最小のAGENTS.mdを書く
この章では、自分のプロジェクトに置く最小のAGENTS.mdを考えます。
最初から立派なAGENTS.mdを書く必要はありません。 むしろ、最初は小さく始めたほうが育てやすくなります。
この章でできるようになること
- 最小のAGENTS.mdに必要な項目を説明できる
- 自分のプロジェクト向けの短いAGENTS.mdを書ける
- AIにAGENTS.mdの下書きを作らせるときの注意点を説明できる
まず小さく始める
AGENTS.mdに最初からすべてを書こうとすると、読みづらくなります。
最小構成では、次の5つがあれば十分です。
- 目的
- 文章やコードの方針
- 編集してよい範囲
- 危険な操作の扱い
- 確認コマンド
教材リポジトリのAGENTS.mdは直接まねしすぎない
この教材リポジトリのAGENTS.mdには、教材制作のための細かいルールが入っています。
たとえば、画像の作り方、章の作り方、commitのタイミングなどです。 これは、この教材を編集するためのルールです。
自分のプロジェクトにそのままコピーすると、不要なルールまで持ち込むことになります。 まずは、自分のプロジェクトに本当に必要なものだけを書きます。
最小の例
たとえば、小さなWebアプリのプロジェクトなら、次のくらいから始められます。
# AGENTS.md
このファイルは、AIコーディングエージェントがこのリポジトリで作業するときの方針を書く場所です。
## 作業方針
- 変更前に、変更予定のファイルと理由を説明してください。
- 学習者向けの文章は日本語で書いてください。
- 既存の設計や命名に合わせてください。
## 安全方針
- `rm`、`chmod`、`chown`、`sudo` を使う前に理由を説明してください。
- `.env`、APIキー、トークン、秘密鍵を表示したり編集したりしないでください。
- ユーザーの許可なしにcommitやpushをしないでください。
## 確認
- 変更後は `git status` と `git diff` を確認してください。
- buildやtestがある場合は、実行できるか提案してください。
この例は、あくまで出発点です。 プロジェクトが大きくなったら、必要になったルールを少しずつ足します。
書く場所
AGENTS.mdは、リポジトリのルートに置きます。
my-project/
AGENTS.md
README.md
src/
package.json
ルートとは、そのプロジェクトの一番上のディレクトリです。
git status を実行したときに、そのリポジトリ全体の状態が見える場所だと考えるとわかりやすいです。
やってみる
自分の成果物リポジトリ、または練習用リポジトリで、AGENTS.mdに入れたい項目をメモします。
ここでは、まだ実ファイルを編集しなくても構いません。 まずは次を埋めます。
このプロジェクトの目的:
AIに守ってほしい文章やコードの方針:
AIに触ってよい場所:
AIに触ってほしくない場所:
危険な操作として事前確認してほしいもの:
変更後に確認してほしいコマンド:
教材リポジトリのAGENTS.mdを編集する必要はありません。 ここで作るのは、自分のプロジェクト用の下書きです。
AIに聞いてみよう
AIに下書きを作らせる場合も、まずは短く作らせます。
私のプロジェクト用に、最小のAGENTS.mdの下書きを作りたいです。
次の条件で作ってください。
- まず質問を5問してください
- 一問一答形式にしてください
- 1問ずつ質問し、私の回答を待ってください
- 各質問では、A/B/Cの選択肢も毎回表示してください
- 5問が終わったら、AGENTS.mdの短い下書きを出してください
- 最初から長くしすぎず、必要最低限にしてください
- まだファイルは作成しないでください
確認したい観点は、プロジェクトの目的、文章やコードの方針、編集してよい範囲、禁止事項、確認コマンドです。
このプロンプトでは、AIに先に質問してもらいます。 自分で方針を全部書き出すより、抜けを見つけやすくなります。
何が起きたのか
AGENTS.mdは、最初から完成版を目指すファイルではありません。
AIとの作業で、同じ説明を何度もしていること、毎回やり直していること、危なかった操作を見つけたら、少しずつ追加していきます。
この章では、AGENTS.mdを小さく始めるための出発点を作りました。 次章では、同じ依頼をAGENTS.mdの変更前後で比べ、ルールがAIの出力にどう効くかを確認します。
次へ
次は、同じ依頼をAGENTS.mdの変更前後で比べます。