groove-work-doc

groove-work-doc

指定されている場合は、$ARGUMENTS をドキュメントのトピックとして使用します。

成果

コンポーネント、概念、またはパターンの仕組みを説明する構成化されたドキュメントファイルです。コードベースを引き継ぐ今後のエージェントや人間を対象とします。

受け入れ基準

ドキュメントファイルに以下が含まれていること：

• 概要：このコンポーネント／概念とは何か、どのような問題を解決するのか
• 主要ファイル：最も重要なファイルと、それぞれの役割を一行で記載
• 仕組み：主要なフローやロジックを段階的に説明
• 注意点：自明ではない制約、エッジケース、既知の落とし穴

制約

• トピックをファイル名として使用できるようにサニタイズします。パス区切り文字、特殊文字、パストラバーサルパターン（../）を取り除きます
• ドキュメントディレクトリは常に .groove/memory/docs/ とします
• ドキュメントディレクトリが存在することを確認し、なければ作成します
• 作成前にコードベースを十分に調査します（Explore エージェントを使用）。ドキュメントには一般的な説明ではなく、実際のファイルパスを記載します
• 対象範囲が曖昧な場合は、ユーザーに「対象読者は、新しいコントリビューター、将来のエージェント、それとも両方ですか？」と確認します
• 一般用途エージェントを使用し、独立したコンテキストでドキュメントを作成します
• 完了前に、必須の4つのセクションがすべて存在することを確認します
• 各セクションは簡潔にまとめます。チュートリアルではなく、参照用ドキュメントです

品質の指標

• 「主要ファイル」には、コードベースで見つかった実際のパスが記載されている
• 「仕組み」では、実際の実行経路をたどっている（例：「ユーザーが X を実行 → Y が設定を読み取る → Z がファイルを書き込む」）
• 「注意点」では、コードを読むだけでは気づきにくい点を明らかにしている
• 仕様書にすでに記載されている内容を重複させていない。仕様書がある場合はリンクする