documentation-generation-doc-generate
コードから包括的なドキュメントを生成
ドキュメントをコードと自動的に同期させます。このスキルはソースコードから情報を抽出してAPI仕様、アーキテクチャ図、ユーザーガイドを作成し、コードベースの進化に合わせて常に最新の状態を保ちます。
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「documentation-generation-doc-generate」を使用しています。 src/routes/内のPython APIルートを分析
期待される結果:
- OpenAPI 3.0仕様ファイル (openapi.yaml)
- 対話型APIドキュメントHTMLページ
- 各エンドポイントのPython、JavaScript、cURLのコード例
「documentation-generation-doc-generate」を使用しています。 マイクロサービスアーキテクチャを文書化
期待される結果:
- サービス間の関係を示すシステムアーキテクチャ図
- 技術スタックと責任を含むコンポーネントドキュメント
- 主要なビジネスプロセスのデータフロー図
セキュリティ監査
安全This skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.
品質スコア
作れるもの
APIドキュメント生成
コードベースの注釈とルート定義から、OpenAPI仕様と対話型APIドキ��メントを自動的に生成します。
アーキテクチャドキュメント
インポート、依存関係、コード構造を分析することで、システムアーキテクチャ図とコンポーネントドキュメントを作成します。
ドキュメントパイプラインの自動化
コードのコミットごとにドキュメントを再生成してデプロイし、ドキュメントを同期させるCI/CDワークフローを設定します。
これらのプロンプトを試す
./src/api/ディレクトリ内のPythonファイルを分析し、すべてのエンドポイント、リクエスト/レスポンススキーマ、認証要件を含むOpenAPI 3.0仕様を生成してください。
コード構造に基づいて、インストール手順、設定オプション、使用例、コントリビューションガイドラインを含む包括的なREADME.mdを作成してください。
サービスモジュールとそのインポートを調べ、システムアーキテクチャ、データフロー、コンポーネントの依存関係を示すMermaid図を作成してください。
APIリ��ァレンス、アーキテクチャ概要、スタートガイド、デプロイ手順を含む完全なドキュメントを生成してください。検索機能付きで生成されたアーティファクトを使用してドキュメントサイトを設定してください。
ベストプラクティス
- ド��ュメントとコード変更を同期させるために、CI/CDの一部としてドキュメント生成を実行
- カバレッジがしきい値を下回った場合にビルドを失敗させるドキュメントカバレッジチェックを含める
- 正確性のために生成されたドキュメントをレビューし、必要に応じて人間によるコンテキストを追加
回避
- ドキュメントを一度だけ生成し、コードの進化に合わせて更新しない
- 正確性の人間によるレビューなしで生成されたドキュメントを公開する
- 生成されたドキュメントにAPIキーや内部URLなどの機密情報を含める