AIがサクサク動くコードベースにしよう


コードベースの状態によってはAIを使っても生産性が上がりにくいことがあります。どのようなコードベースだとAIが力を発揮しやすいでしょうか。以下を参考にしてみてください。

コードは短く

コードが短いほうがコンテキストに収まりやすいです

ファイルを責務ごとに分割し、凝集度を高くする

必要な情報がコンテキストに収まりやすくなります。影響箇所が少ないほうがコンテキスト読み出しが不要になり安定します。

特にAIエージェントの場合、最低限のコンテキストだけを読む事が多いので大事です。無関係な読み出しで時間をつかったり迷走したりするのは避けたいところ

不要な設定やメッセージ用テキストは別ファイルに分離する

普段は読まなくてすむのでコンテキストが節約できます。

コメントは無駄なく丁寧に

コメントがあるほうがAIが理解しやすくなります。特にWhyはコードベースからは読み取りづらいのでWhyを書きましょう

かといって見ればわかることはコンテキストの無駄なので避けましょう

変数名は丁寧に

変数名が適切ならAIが理解しやすくなります。

ディレクトリ構造に秩序を

どこに何があるか、時間をかけて探さなくて済むようにしましょう

主流のライブラリ/ツール等を使う

主流のほうが学習サンプルが多いため精度が高くなります

ドキュメントがしっかりしたライブラリ/ツールを使う

ドキュメントが細かいほうが読ませたときに精度が高くなります

テストを厚めに書く

テストが多いほうが修正ミスを捉えやすくなります また、テストから仕様がわかるためスムーズに理解できるようになります。

開発ドキュメントを書く

ドキュメントを読ませることでお互いの前提が揃い、同じ間違いが減ります。やり方や場所をまとめておきましょう。AIは記憶喪失が起きるので毎回教えてあげる必要があり、それが簡単なほうが便利です。

ビルドやテスト時間は短く

イテレーション速度が上がり、単位時間あたりのアウトプットが増えます。 AIの思考や記述時間よりこちらがネックになることがあります。

これらの部分もAIで高速化しましょう

診断/デバッグ方法を準備しておく

複雑な不具合はデバッグログや機能のon/offなどで診断できるようにしましょう。AIエージェントが実行できるぐらい平易だとよいですね

このような部分もAIで作りましょう

さいごに

整理整頓されたコードベースとそうでないコードベースでは、AIが出せる生産性に差が生まれます。

AIの生産性を上げるために、AIでコードベースを洗練させましょう。