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