mcpField
G
generate-docs

generate-docs

github.com/gtrabanco開発2271 回インストール今日更新
リポジトリ

generate-docs について

generate-docs は、完了した作業単位をプロジェクトのドキュメントサイト向けガイドに段階的にまとめるエージェントスキルです。設定済みのドキュメントアダプターを特定し、出典情報付きのページを作成して検証したうえで結果を報告します。

主な機能

  1. 01完了した作業からガイドを段階的に生成
  2. 02ドキュメントアダプターの検出と解決
  3. 03生成ページへの出典情報の付与
  4. 04ドキュメントビルドまたはリンク検証
  5. 05所定形式の完了レポート

活用シーン

  1. 01完了した作業単位の内容を文書化
  2. 02指定したプロジェクト領域のドキュメント生成
  3. 03既存のレビュー報告をドキュメントページとして公開

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/gtrabanco/agentic-workflow --skill generate-docs

インストール後、Claude Code で/generate-docsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
ADAPTER_DISCOVERY.md
ADAPTERS.md
GENERATION_PROCESS.md

詳細

ドキュメントの生成

作業単位で得られた知見を、プロジェクトのドキュメントサイトでコントリビューターが読める開発者向けドキュメントにまとめます。リリースの副産物として段階的に作成することで、公開リポジトリのドキュメントを古くならないように保ちます。コミットには何が変わったかを記し、ガイドには使い方(「ドメインイベントを作成するにはどうすればよく、そのハンドラーはどこに登録するのか」)を記します。

ターンの完了条件 — ターンを終える前に確認してください

✓ The docs adapter was resolved through the Step 0 detection checklist and the
  outcome (adapter name, or NOT CONFIGURED) is stated in the report
✓ Every generated/updated page is WRITTEN to disk (paths listed in the report)
  and carries the provenance frontmatter — or zero pages were written and the
  report says exactly why
✓ The verify step was RUN (docs build command or link check) and its result
  pasted — never assumed
✓ Artifact language: explicit user instruction > the project's declared docs
  language > English. The CONVERSATION language never decides
✓ The fixed report block is printed, then the closing `→ Next:` block, as the
  ABSOLUTE last output

未チェックの項目があるままターンを終えようとしていますか?そのターンはまだ完了していません。まず未完了の項目を済ませてください(性能の低いモデルはドキュメント末尾の作業を忘れがちなので、このリストを最初に置いています)。

使用するタイミング

  • 作業単位を終えた後 — プロジェクトにドキュメントサイトがある場合、execute-phase は終了時にこのスキルの使用を推奨します。文脈が新鮮なうちに、その作業単位で変更した内容を記録してください。
  • 特定の領域について必要に応じて:generate-docs src/domain/events/。
  • --review — 最新の review-change レポートをドキュメントページとして出力し、Web サイトから人が所見を確認できるようにします。
  • SPEC/計画ドキュメント(plan-feature)、セッション記録(log-session)、コードレビューには使用しません(所見の生成は review-change の役割です。このスキルは、依頼があった場合に既存のレポートを公開するだけです)。

段階的な読み込み — ドキュメントの出力先を解決する

参照先の許可リストは、以下の3つのパスだけです。次の順で読み込んでください。選択されたリソースはすべて規範的なもので、このエントリーポイントから1ホップ先にあります。

  1. 呼び出しのたびに、アダプターの検出を読み、根拠に基づいてアダプターを特定してください。NOT CONFIGURED の場合は書き込みを中止します。
  2. アダプターが設定されている場合に限り、出力先や形式を選ぶ前にアダプターのスロットを読んでください。
  3. 生成プロセスを読み、対象範囲、段階的な生成、マップ/レビュー、検証、レポートの各手順を実行してください。

NOT CONFIGURED の後に手順2〜3を読み込まないでください。必須リソースが見つからない場合は中止し、アダプター、出力先、固定の契約を決して推測しないでください。

許可事項と禁止事項(固定リスト — 解釈しないこと)

許可事項:

  • アダプターのガイド配置場所にあるページの作成・更新
  • アダプターの表で必要とされている場合に限り、アダプターが指定する手動編集のサイドバー設定を更新すること
  • 指定されたドキュメントのビルド/検証コマンドを実行すること
  • あらゆるもの(差分、コード、ドキュメント)を読むこと

禁止事項 — 「役に立ちそう」でも絶対に行わないこと:

  • プロジェクト全体のドキュメント再生成(ページの選択に使えるのは段階的生成のチェックリストのみ)
  • ソースコード、テスト、またはアダプターが指定する手動編集のサイドバー設定以外の設定ファイルを編集すること
  • ドキュメントサイトの雛形を作成すること(Astro/Starlight のインストール、設定ファイルの作成など)
  • アダプターが指定するコンテンツの配置場所の外に書き込むこと。ただし、指定された手動編集のサイドバー設定を除く
  • 出所情報を示す frontmatter がないページを作成すること
  • コミットやプッシュを行うこと(コミットは作業単位のワークフローで行います)

以下の内容をそのまま返す

GENERATE DOCS — adapter: <starlight|docusaurus|markdown|NOT CONFIGURED> — scope: <scope>

| Page | Action | Source-unit | Subject paths |
|---|---|---|---|
| <content-path> | created|updated | <NN-slug> | <paths> |

Map: regenerated (<command>) | n/a — no map command declared | invalid output — <reason>
Review export: <page path> | not requested | no report available
Verify: <command + exit code | links checked: <n>, broken: 0 | n/a — not configured>
Pages: <n> written, <n> skipped by incrementality checklist
Decision: PASS | FAIL | NOT-CONFIGURED

FAIL は、検証手順が失敗した場合、または作成したページを元に戻す必要があった場合に限ります。手順0.5に従って NOT-CONFIGURED を返します。それ以外は(ページが0件の場合も含めて)PASS を返します。

移植性(Claude Code 以外のエージェント向け)

ワークフローが契約であり、Claude Code の機能は利便性のためのものです。その機能がないエージェントでは、代替手段を使い、その機能が可能にする手順を決して省略しないでください。

  • スラッシュコマンドメニューがない場合 — このスキルで /<skill> と指定されている箇所では、そのスキルの SKILL.md を開き、新しい会話で内容どおりに従ってください。
  • スキルごとの model:/effort: がない場合 — ガイドの作成は差分に基づく構造化された要約です。中程度のモデルで十分です。プロジェクトの言語を正確に読める段階より低いモデルは使わないでください。
  • 引数を渡せない場合 — 呼び出しメッセージに対象範囲(「01-generate-docs のドキュメントを生成する」など)を記載してください。手順のステップ1の順序は引き続き適用されます。

他のスキルとの関係

  • execute-phase は、ドキュメントマップでドキュメントサイトが宣言されている場合、ユニットの完了時にこのスキルを推奨します(→ Next: で引き継ぎます。このターン内で組み合わせることはありません)。
  • audit-docs は、出所を示すフロントマターを使って、参照されていない、または古くなった生成ページを検出します。
  • init-workspace は、このスキルのステップ 0 が読み取る Docs site の宣言を記録します。
  • レビューではありません。指摘事項や品質の確認は review-change が担当します。

完了条件

  • アダプターの結果が根拠とともに示されており、選択したすべてのページに出所を示すフロントマターが記述され、検証ステップが実行されて成功していること(または、NOT-CONFIGURED レポートが出力され、何も書き込まれていないこと)。

  • 固定のレポートブロックが返され、その後に:

    → Next: commit these pages with the unit's close-out (they ride the unit's PR)
      · unit already closed → commit as docs(<unit>): generated guides on the unit's branch
      · adapter NOT CONFIGURED → add the Docs site block to the documentation map, then re-run /generate-docs
    

コメント