qnote Advent Calendar 2025 の3日目です。
最近OpenAIのCodexを使うようになりました、新規案件で使用していて開発は大分早くなりました。
使い始めて約3ヶ月くらい経ってまだまだ改善点はありますが今のAGENTS.mdファイルでおすすめの内容を共有できればと思います。
AGENTS.md
AGENTS.mdはAIエージェントにデフォルトで与えたい情報をまとめたファイルになります。
例えばプロジェクトで使用する仕様書やドキュメントファイルを指定してプロジェクト毎の情報を与えたりできます。
詳しくは解説している記事を参考にしてください。
おすすめ設定1 応答言語
何も設定していないと英語で返事が返ってくるので日本語で返すようにしています。
・回答は日本語でお願いします
おすすめ設定2 実装内容の事前確認
何も設定していないと勝手に実装を始めてしまうのでワンクッション挟んで提示した実装内容で進めて問題ないか確認するようにしています。
簡単な指示を出しても認識を合わせながら実装方針を進めたりプロンプトで思い通りに指示できていなくても認識違いを吸収できます。
・実装前に変更点を提示してから実装をしてください
おすすめ設定3 アーキテクチャ
SwiftUIのプロジェクトだとViewファイルに全部実装しようとするのでMVVM等のアーキテクチャの指定をしてあげた方が読みやすくなります。
※README.mdに記載してREADME.mdを読み込むようにするのも良いです。
・アーキテクチャはMVVMパターンを採用してください
・README.mdに記載してあるアーキテクチャで実装をしてください
おすすめ設定4 ビルド
沢山案件を抱えているiOS開発者は複数のXcodeバージョンが入っていたりして複数人の開発だと人によってはXcodeのバージョンが違うとか発生するとこともあると思います。
ビルドエラーにならないかとXcodeのバージョンチェックを行うようにもしています。
※通常のXcodeアプリのビルドではなくAIでの自動ビルドになります
・実装後にxcodebuildでビルドが通るか確認してください
・`xcodebuild -version`でXcodeのバージョンを確認してREADME.mdに記載してあるバージョンと一致するか確認して違う場合は警告をするようにしてください
・Xcodeのバージョンが異なる場合は次の動作をしてください
アプリケーションフォルダに複数のXcodeのバージョンが存在するチェック
複数のバージョンがあれば該当のXcodeがあるかチェックし、そのXcodeでビルドするようにしてください
おすすめ設定5 仕様書、ドキュメント
プロジェクトの仕様書やドキュメントがあればフォルダやファイルを指定してあげればそのファイルを元に実装を進めてくれるので指定してあげると良いです。
例
/xxx フォルダに仕様書やドキュメントファイルあるのでそれを元に実装をしてください
初歩的なところだと思うのでそんなの知ってるよって人が多いかもしれないですが誰かの参考になれば幸いです。