まず一言でいうと
Codex指示書は、Codexに「どこを、どう直して、どこで止めるか」を伝える作業メモです。
指示書が具体的だと、Codexは不要なファイルに触れにくくなり、作業後の確認もしやすくなります。
このページで整理すること
Codexへ渡す指示書に入れる項目、書き方、悪い例、良い例、停止条件、報告形式を整理します。
Codexでできること
- 指示書に沿って対象ファイルを確認する
- 指定された範囲だけ修正する
- 確認結果を報告する
- 停止条件に当たったら止める
Codexに任せないこと
- 対象が曖昧なまま全体を直す
- 触らないファイルの判断を丸投げする
- 秘密情報や認証情報を扱う
- 危険作業を軽作業にする
指示書に入れる項目表
| 項目 | 書くこと |
|---|---|
| 目的 | 何を達成したいか |
| 対象URL | どのページを扱うか |
| 対象ファイル | どのファイルを触ってよいか |
| やること | 追加・修正内容 |
| やらないこと | 触らない範囲 |
| 停止条件 | どこで止めて報告するか |
| 確認項目 | 作業後に見ること |
| 報告形式 | どう報告するか |
コピペ用テンプレート
目的:
対象URL:
対象ファイル:
やること:
やらないこと:
触らないファイル:
停止条件:
確認項目:
報告形式:
やってはいけないこと
- 「全部いい感じに」と書く
- 停止条件を書かない
- DBやcronを軽く触らせる
- APIキーや認証情報を貼る
- 報告形式を指定しない
関連ページ
FAQ
Codex指示書は長く書くべきですか?
長さより具体性が大事です。目的、対象、やること、やらないこと、停止条件、確認項目が入っていれば扱いやすくなります。
停止条件は必要ですか?
必要です。分からない、危険ファイルが必要、公式判断が必要、秘密情報が出る場合などは止める条件にします。
テンプレートは毎回使えますか?
使えます。作業ごとに対象URLや触ってよいファイルだけ変えると安全です。
