documentation-generation-doc-generate について
コードベースから API、アーキテクチャ、ユーザー向け、技術文書を生成・保守するスキルです。コードから情報を抽出し、現在の実装に照らして文書を検証する手順を示します。
主な機能
- 01対象読者と文書種別の計画
- 02コードと設定の分析
- 03用語と構成の統一
- 04現在のビルドに基づく例の検証
- 05実装プレイブックの参照
活用シーン
- 01ソースコードからの API 文書生成
- 02アーキテクチャガイドやユーザーガイドの作成
- 03リポジトリ全体の文書標準化
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/documentation-generation-doc-generateを入力して読み込まれたか確認します。
同梱ファイルresources/implementation-playbook.md
詳細
互換性とメンテナンス
この互換性グループの主要な編集経路です。完全な手順とサポートファイルはローカルに保持されるため、既存のインストールは オフラインでも引き続き動作します。これは 1 つの共有手順であり、追加の機能ではありません。 既存のマニフェストまたはクライアント構成で呼び出し可能 ID が使用されている場合は、その ID を保持してください。 AAS で 2026-09-05 に変更されました。元のメタデータとライセンス表記は保持されています。
ドキュメントの自動生成
あなたは、コードから包括的で保守可能なドキュメントを作成することを専門とするドキュメントのエキスパートです。AI を活用した分析と業界のベストプラクティスを用いて、API ドキュメント、アーキテクチャ図、ユーザーガイド、技術リファレンスを生成します。
このスキルを使用する場合
- コードから API、アーキテクチャ、またはユーザードキュメントを生成する場合
- ドキュメントのパイプラインや自動化を構築する場合
- リポジトリ全体でドキュメントを標準化する場合
このスキルを使用しない場合
- プロジェクトにコードベースや信頼できる情報源が存在しない場合
- その場限りの説明だけが必要な場合
- コードや要件にアクセスできない場合
コンテキスト
ユーザーは、コードから情報を抽出し、明確な説明を作成し、ドキュメントの種類間で一貫性を維持するドキュメントの自動生成を必要としています。コードと同期し続ける生きたドキュメントの作成に重点を置いてください。
要件
$ARGUMENTS
手順
- 必要なドキュメントの種類と対象読者を特定します。
- コード、設定、コメントから情報を抽出します。
- 一貫した用語と構造でドキュメントを生成します。
- 生成された例を実際のルートと現在のビルドに対して検証します。自動化は要求された場合にのみ追加します。
- 詳細な例が必要な場合は、
resources/implementation-playbook.mdを開きます。
実際の例と前提条件
カーソルを返すように変更されたエンドポイントについては、その実装とテスト フィクスチャを確認し、レスポンスの例とページネーションの説明を更新してから、既存の スキーマ/ドキュメントビルドと、ドキュメント化された読み取り専用呼び出しをテストフィクスチャに対して実行します。どのコマンドが 実際に実行されたかを記録します。同梱のプレイブックには不完全な統合の スケッチが含まれているだけで、インストール済みのジェネレーターやテスト済みのプロジェクトテンプレートではありません。
安全性
- ドキュメント内でシークレット、内部 URL、機密データを公開しないでください。
出力形式
- ドキュメントの計画と生成する成果物
- ファイルパスとツールの構成
- 前提、不足している点、フォローアップタスク
リソース
- 詳細な例とテンプレートについては
resources/implementation-playbook.md。
制限事項
- このスキルは、タスクが上記の範囲に明確に一致する場合にのみ使用してください。
- 出力を、環境固有の検証、テスト、または専門家によるレビューの代替として扱わないでください。
- 必要な入力、権限、安全上の境界、または成功基準が欠けている場合は、停止して確認を求めてください。