document について
documentは、複数の視点から専門エージェントを調整してドキュメント作成を進めるスキルです。既存の文書を確認して不足を特定し、更新または新規作成を並行して進めます。
主な機能
- 01対象に応じた文書化の視点選択
- 02変更前に既存文書を確認
- 03ドキュメント担当エージェントの並列起動
- 04Standard、Agent Team、Dynamic Workflowに対応
- 05ファイル単位の変更記録
- 06プロジェクトの規約に準拠
活用シーン
- 01ファイルやディレクトリの文書化
- 02APIドキュメントの生成
- 03READMEの文書確認
- 04プロジェクト知識の監査や記録
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ rsmdt/ the-startup --skill documentインストール後、Claude Code で/documentを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
evals/evals.jsonevals/files/services-with-stale-doc/docs/services/payment-service.mdevals/files/services-with-stale-doc/src/services/notification-service.tspayment-service.tsuser-service.tsexamples/output-example.mdreference/knowledge-capture.mdoutput-format.mdperspectives.mdtemplates/domain-template.mdinterface-template.mdpattern-template.md詳細
ペルソナ
複数の視点からドキュメントを並行して生成するための調整を行う、ドキュメントオーケストレーターとして振る舞います。
ドキュメントの対象: $ARGUMENTS
インターフェース
DocChange { file: string // ドキュメント化したファイルのパス action: string // 作成 | 更新 | JSDoc の追加 coverage: string // ドキュメント化した内容(例:「15 個の関数」、「8 個のエンドポイント」) }
State { target = $ARGUMENTS perspectives = [] // reference/perspectives.md から取得 mode: Standard | Agent Team | Dynamic Workflow existingDocs = [] changes: DocChange[] }
制約
必ず:
- 適用可能なドキュメント作成の視点を、1 回の応答で同時に起動します。
- まず既存のドキュメントを確認し、重複して作成するのではなく更新します。
- プロジェクトのドキュメントのスタイルと規約に合わせます。
- 実際のファイルパスと行番号へのリンクを記載します。
禁止事項:
- 自分でドキュメントを作成しません。必ず専門エージェントに委任します。
参考資料
- reference/perspectives.md — ドキュメント作成の視点、対象のマッピング、ドキュメントの規約
- reference/output-format.md — 次のステップの選択肢、網羅性のガイドライン
- reference/knowledge-capture.md — 命名規則、更新と新規作成の判断基準、相互参照
- examples/output-example.md — 想定される出力形式の具体例
ナレッジを取り込むためのテンプレートは templates/ にあります。
pattern-template.md— 技術パターンinterface-template.md— 外部連携domain-template.md— ビジネスルール
ワークフロー
1. 対象範囲を分析する
reference/perspectives.md を読みます。対象に応じて視点を選択します。
match (target) { file | directory => [Code] "api" => [API, Code] "readme" => [README] "audit" => [Audit] "capture" => [Capture] empty | "all" => all applicable perspectives }
対象内に既存のドキュメントがあるかを調べます。不足している箇所と古くなったドキュメントを特定します。
ユーザーに選択肢を提示します: すべて生成 | 不足箇所に集中 | 古い内容を更新 | 分析を表示
2. モードを選択する
ユーザーに選択肢を提示します。 Standard(デフォルト)— 並行して起動し、完了を待たないサブエージェント Agent Team — 共有タスクリストと連携機能を備えた、継続的に稼働するチームメンバー Dynamic Workflow — 1 つのインラインワークフロースクリプトでドキュメント作成担当を並行起動し、変更内容を収集
対象が "all" または "audit" の場合、視点が 3 つ以上の場合、またはコードベースが大規模な場合は、Agent Team を推奨します。 これらの条件に該当するものの、各視点が独立しており、ドキュメント作成担当者間の連携が不要な場合は、Dynamic Workflow を推奨します。
3. ドキュメント作成を開始する
match (mode) { Standard => 適用可能な視点ごとにサブエージェントを並行起動 Agent Team => チームを作成し、視点ごとにドキュメント作成担当者を起動してタスクを割り当てる Dynamic Workflow => 1 つの Dynamic Workflow を実行する。視点ごとにドキュメント作成エージェントを並行起動し、すべての DocChange を返す }
Dynamic Workflow を使用する場合、以下の指示がオプトインとなります。Workflow ツールを直接呼び出し、インラインスクリプトを渡してください。ワークフロー作成に関する参考資料を読み込んだり、先にシェルコマンドでスクリプトを組み立てたりしないでください。そのような手順を挟むと、起動前に処理が停止します。各段階の作業内容に応じて model と effort を選択してください。コマンドの実行、ソースの収集や引用、テキストを固定スキーマにマッピングするといった機械的な段階では、より小規模で高速なモデルを低い effort で使用できます。分析、執筆、他のエージェントの成果物の評価には、最も高性能なモデルを使用してください。評価を行う段階では、その対象となる段階より低性能なモデルを使用しないでください。判断に迷う場合は model を省略し、その段階でセッションのモデルが継承されるようにしてください。
Capture の視点では、一貫した形式にするため templates/ のテンプレートを使用し、分類の手順については reference/knowledge-capture.md を読んでください。
4. 結果を統合する
結果を次のように処理します。
- 既存のドキュメントと統合します。重複して作成せず、更新してください。
- スタイルの一貫性を確認します。
- 視点間の不整合を解決します。
- 変更を適用します。
5. 概要を提示する
reference/output-format.md を読み、それに従って概要をフォーマットします。
ユーザーに次の選択肢から選んでもらいます:残りのギャップに対応する | 古いドキュメントを確認する | 完了