生成AI readableなコードベースを作る(話が古い。後で別稿を記す)
個別のサービスのconfigには触れない。あくまでコードベース・ドキュメントのミニマムな改善を考える。
生成AIやその支援系を利用したコーディングは今後益々活用されていくことと思うが、そのためにコードベースを整えるといった行動を開発者側で行うことが(少なくとも現状は)望ましい。ここでは2025年段階での発想をまとめておく。
予め結論をまとめると、ここに書かれてあるプラクティスは人間に読ませる場合にも有効であり、思考の流れのままに任意のコードの在処を探索できるようにプロジェクトを整えておくことが大事、である。ただし、人間にとってはやや過剰に思える注釈を加えた方がAI的には通りが良かったりはする。
----
とりあえず、当たり前な話としては以下がある。
README.mdファイルを辿ることで、AIがモジュール構成を把握できる状態にする
ファイルのオートローディング機構がある言語の場合(ex: PHP)、その標準的な仕様(ex: PSR-4)に則る
実装を覗かなくても主作用・副作用が明確に把握できるInterfaceを構成する
プロジェクトルートに配置するREADME.mdに関しては特に
サブディレクトリ名とその責務の説明を書き込む
configファイル類の所在を明らかにする(特にプロジェクトルートにない場合)
プロジェクトに固有の規約は外部DocサービスではなくRepositoryに載せ、その所在を明らかにする
あるいは、何らかの形で外部Docサービスをソースとしつつ、Repoに転写commitが入るような機構を作る
と良い
また、タスクランナー系に関しては、そのdescriptionをしっかり目に書き込んでおく。
## DBに関して
GUIのDBクライアントアプリケーションで高機能なものだと接続先DBのスキーマをenbeddingした上で生成AIによるクエリ補完などを行なってくれることもある。
これに頼れない環境の場合は、プロンプトとしてDBスキーマの必要な範囲をすぐに渡せるようにしておくと良い。