エージェントドキュメント規律 は何をしますか?
このスキルは、エージェントが行動するために消費するドキュメント(5つのサーフェス(CLAUDE.md、CONTEXT.md、docs/standards/、design-system/、.omc/skills/)、仕様、チケット、スキルファイル)を作成・編集する際に記述規律を適用するために使用します。ドキュメントが満たすべきテスト条件は次のとおりです。新しいエージェントセッションが、ドキュメントを読むだけで行動できること。
必須の場合:drydockがサーフェスシードを生成するとき、起動C5セディメントパスがレッスンをスロットに書き込むとき。それ以外の編集ではオプトインですが、エージェント向けドキュメントへの編集はこれらのルールを満たすべきです。
使用すべきでない場合
人間専用のドキュメント:docs/business/ ナラティブ、ADR決定ストーリー、人間のオンボーディング用のREADME。これらのドキュメントは、コストがかからない場合に限りルールに従うことができますが、この規律の対象にはなりません。
規律
会話履歴のない読者のために書く。 ドキュメントは自己記述的であり、「議論したように」、以前のセッション、または誰かの頭の中にある知識に依存してはなりません。テスト: まったく新しいエージェントセッションが、ドキュメントを読むだけで行動できること。
すべてのルールはチェック可能であり、「なぜ」を伴うこと。 「きれいに保つ」だけでは不十分です。観察可能な条件と理由を記述してください。テスト: エージェントがテキストだけで合格/不合格を判断でき、理由がルールの隣に記述されていること。
一つの意味、一つの場所。 各ルールまたは定義には単一の信頼できる場所があります。重複はやがてずれを生みます。テスト: 振る舞いを変更するには、一箇所の編集で済むこと。
環境が示すことを決して再記述しない。 パッケージスクリプト、ディレクトリレイアウト、--help 出力は参照するものであり、ドキュメントではありません。コピーした参照は古くなります。ドキュメントには、見ただけでは見つけられないものだけを記述してください。文書化されていない慣習、選択の背後にある理由、ハマりどころなど。テスト: すべての行が「これは他の場所で参照できるか?」という問いに耐えられること。
手順を先に、参照を後で、稀な資料はポインタの後ろに。 何をすべきか、順序に沿って上部に配置し、オンデマンドで参照するルールはその下に配置します。頻度の低い資料は、それを参照すべき分岐を名前で示すポインタの後ろに押し込みます。テスト: 次のアクションが最初の画面内で見つけられること。
各手順は完了条件で終わる。 完了したかどうかがわからなければなりません。曖昧な境界は時期尚早な完了を招きます。テスト: 各手順について、「これが完了したかどうかはどうやってわかるか?」という問いに対する答えがテキスト内にあること。
肯定形で促す。 目標とする振る舞いを記述してください。禁止はハードなガードレールのために予約され、常に肯定形の目標と対にして記述されます。テスト: ドキュメント内のすべての禁止は、代わりに行うべきことを名前で示していること。
書き込み時にバーナクルを削り取る。 ドキュメントに古いまたは冗長な内容が含まれている場合は、同じ編集で削除します。含まれていない場合は、必要な内容のみを追加し、削除をでっち上げないでください。モデルがデフォルトですでに従う文は負荷のために存在するだけです。その文全体を削除してください。テスト: すべての行を再読し、「これはデフォルトと比較して振る舞いを変えるか?」という問いに耐えられることを確認し、編集時に見つかった古いまたは冗長な内容は削除されていること。
検証
ドキュメントの変更が完了したと報告する前に、以下を確認してください。
- 新しいセッションが人間に何も尋ねずにそのドキュメントに基づいて行動できること
- すべてのルールがチェック可能であり、その理由が明記されていること。どのルールも参照の再記述ではないこと
- 意味が一箇所に存在し、ポインタがそのトリガーとなる分岐を名前で示していること
- 編集時に見つかった古いまたは冗長な内容は削除され、有効な無関係な内容は保持されていること