$docdiet
このスキルは、ユーザーが明示的にドキュメントのレビュー、クリーンアップ、または更新を要求した場合(通常は$docdietを呼び出した場合)にのみ使用します。これはスタンドアロン型のオンデマンドレビュー/更新スキルであり、タスクごとに自動的に実行されるものではありません。ユーザーが指定した、または要求された変更によって明確に示されたドキュメント範囲のみをレビューまたは更新し、無関係な監査を開始しないでください。
$docdiet all docsや$docdiet project-wideのような明示的な要求は、範囲を限定したプロジェクト全体のパスを許可します。このモードでは、リポジトリルート配下の.md、.mdx、.rst、.adoc拡張子を持つドキュメントファイル、およびルートレベルのREADME*とCONTRIBUTING*ファイルに範囲が限定されます。生成されたファイルやベンダー管理のディレクトリとファイル、変更履歴/リリースノート、ライセンスや法的資料、行動規範、リポジトリ保護ファイルは除外します。ファイルの検出は、それらの拡張子と除外条件を使用した1回のrg --filesリストに限定され、最大200パスとします。そのリストで返されたパスのみを検査します。変更された公開コンセプトに対して、追加で1回だけ、正確でパスが制限されたrg -l -F参照検索を使用できます。上限または検索境界に達した場合は、レビュー未完了の残りを報告し、範囲を拡大しないでください。
判断ルール
- 最初に範囲を判断する。 ドキュメントファイルやセクションが指定されておらず、ドキュメントに触れておらず、公開された名前変更/削除で参照チェックが必要ない場合は、停止します。ドキュメントを検査するかどうかを判断するためにドキュメントを検査しないでください。
- 正規のソースを編集する。 開発者、ユーザー、オペレーター、メンテナーが必要とする永続的な情報(契約、セットアップ、設定、運用、制約、不変条件、非自明な動作、移行、重要な警告)のみを文書化します。実装の細部、一時的な状態、デバッグ履歴、推測された事実、完了サマリーは省略します。
- 蓄積ではなく置き換える。 既存の説明を更新し、廃止されたテキストを削除し、別のドキュメントでポインタが必要な場合は1つの正規ソースにリンクします。歴史的な詳細は、移行、互換性、またはアーキテクチャ上の根拠のためにのみ保持します。
- クリーンアップを局所的に保つ。 ドキュメントファイルを編集する際は、触れたセクションとその近辺のテキストで、明らかに古くなっている、重複している、矛盾している、取って代わられている、誤解を招く、不必要に冗長である、変更/削除された概念に関連しているという証拠があるもののみをクリーンアップします。証拠を得るために実質的な調査が必要な場合は、そのままにしておきます。
- 参照検索に境界を設ける。 名前変更、削除、変更された公開コンセプトに対しては、最大1回の正確でパスが制限された検索が許可されます。ドキュメントのglobを使用した
rg -l -Fを優先し、一致する行全体ではなくファイル名を報告します。上記の明示的なプロジェクト全体モード以外では、無関係なドキュメントの棚卸し、ドキュメントツリーの閲覧、リポジトリ全体のリンクチェック、無関係な履歴の調査、クリーンアップエージェントの作成を行わないでください。 - ファイルはめったに作成しない。 永続的で明確な情報であり、タスクから既に知られている適切な正規の格納場所がない場合にのみ、ドキュメントファイルを追加します。
保護
生成されたドキュメント、変更履歴/リリースノート、ライセンスや法的資料、行動規範、ベンダー管理/サードパーティのドキュメント、リポジトリ保護ファイルを日和見的に書き換えないでください。リポジトリの指示に従い、意味のあるフロントマターとメタデータを保持してください。
Markdownファイルに以下が含まれている場合:
---
disable-agentic-editing: true
---
ユーザーが明示的にそのファイルを要求しない限り、変更しないでください。このマーカーはdocdietの規約です。どのツールもこれを強制せず、リポジトリの指示でその保護を解除することはできず、そのファイルに対する明示的な要求のみがこれを上書きします。保護は候補ファイルについてのみ確認し、リポジトリ全体でマーカーをスキャンしないでください。
完了
ドキュメントに触れた場合は、触れたファイル/セクションのみを静的にチェックします。最終的な動作が必要な場所に文書化されていること、廃止されたテキストが証拠をもってのみ削除されていること、例やコマンドが実装とまだ一致していること、保護されたコンテンツが変更されていないことを確認します。プロジェクト全体モードでは、これらのチェックを触れた各ファイルに適用し、検証をリポジトリ全体のリンクや例のチェックに拡大しないでください。実装タスクがすでにそれを必要としない限り、例やコマンドを実行しないでください。その後、停止します。
永続するものを文書化せよ。蓄積するのではなく置き換えよ。タスクが明らかにしたものをクリーンアップせよ。狩ってはいけない。