スキル code-documentation-doc-generate
📦

code-documentation-doc-generate

安全

コードドキュメ���トを自動生成

AIを活用した分析により、ソースコードから包括的なAPIドキュメント、アーキテクチャ図、ユーザーガイド、技術リファレンスを作成します。

対応: Claude Codex Code(CC)
🥉 75 ブロンズ
1

スキルZIPをダウンロード

2

Claudeでアップロード

設定 → 機能 → スキル → スキルをアップロードへ移動

3

オンにして利用開始

テストする

「code-documentation-doc-generate」を使用しています。 Generate API documentation for a FastAPI user service with endpoints for create, read, update, delete users

期待される結果:

  • APIドキュメントが作成されました：
  • - OpenAPI 3.0仕様
  • - ユーザーエンドポイント（/users、/users/{id}）
  • - 検証付きリクエスト/レスポンススキーマ
  • - 認証と認可のセクション
  • - 各エンドポイントのcurlコマンド例

「code-documentation-doc-generate」を使用しています。 Create a README for a Python CLI tool that converts images to PDF

期待される結果:

  • READMEが生成されました：
  • - プロジェクトタイトルと説明
  • - インストール手順（pip、conda）
  • - 例を使用したクイックスタートガイド
  • - 設定オプション表
  • - ライセンスとコントリビューションガイドライン

セキュリティ監査

安全
v1 • 2/25/2026

All 91 static findings are false positives triggered by documentation examples in the skill. The skill provides templates and examples for generating documentation. No actual code execution, network calls, or credential access occurs. Risk level: SAFE.

2
スキャンされたファイル
692
解析された行数
1
検出結果
1
総監査数
低リスクの問題 (1)
resources/implementation-playbook.md:1-641SKILL.md:1-51
Static Scanner Pattern Detection in Documentation Examples
The static scanner detected 91 potential security patterns in documentation examples. These findings are false positives triggered by template variables (${VARIABLE}), code block fences (```), and example URLs in the implementation playbook. No actual code execution, network calls, or credential access occurs.
監査者: claude

品質スコア

38
アーキテクチャ
100
保守性
87
コンテンツ
50
コミュニティ
100
セキュリティ
100
仕様準拠

作れるもの

WebサービスのAPIドキュメント

RESTエンドポイントコードからOpenAPI仕様と対話型APIドキュ��ントを自動生成

プロジェクトREADMEの生成

インストール、使用例、コントリビューションガイドラインを含む包括的なREADMEファイルを作成

アーキテクチャドキュメント

コード構造からシステムアーキテクチャ図とコンポーネントドキュメントを生成

これらのプロンプトを試す

基本的なAPIドキュメント 
Generate API documentation for the endpoints in this codebase. Include request/response schemas, authentication requirements, and example requests.
完全なプロジェクトREADME 
Create a comprehensive README.md for this project. Include: project description, installation steps, usage examples, configuration options, and contribution guidelines.
アーキテクチャ概要 
Analyze the codebase structure and generate architecture documentation. Include a system diagram, component descriptions, data flows, and technology stack summary.
ドキュメント自動化のセットアップ 
Set up automated documentation generation for this project. Include CI/CD configuration, doc linting rules, and deployment to a documentation hosting platform.

ベストプラクティス

  • 常にテストを通じて生成されたドキュメントが実際のコードの動作と一致するか検証
  • CI/CD自動化を使用してドキュメントをコードと同期
  • ユーザーがコピーして適用できる実用的なコード例を含める

回避

  • 正確性をレビューせずにドキュメントを生成
  • APIキーや内部URLなどの機密情報を公開ドキュメントに含める
  • 自動的に検証またはテストできないドキュメントを作成

よくある質問

このスキルはどのような種類のドキュメントを生成できますか？
この��キルは、APIドキュメント、アーキテクチャ図、READMEファイル、ユーザーガイド、技術リファレンスを生成できます。OpenAPI/Swagger仕様、Mermaid図、様々なドキュメント形式をサポートしています。
このスキルはプロジェクトのコードを実行しますか？
いいえ。このスキルはコードを分析して構造を理解し、その分析に基づいてドキュメントを生成します。コードベースを変更または実行することはありません。
CI/CDパイプラインに統合できますか？
はい。GitHub Actions、GitLab CI、または類似のプラットフォームを使用して、CI/CDパイプラインでの自動ドキュメント生成をセットアップするためのガイダンスが含まれています。
どのプログラミング言語がサポートされていますか？
このスキルはどのプログラミング言語でも動作します。コード構造を分析し、言語に依存しないドキュメントを生成します。特定の言語サポートは、ドキュメント形式（JavaScriptのJSDoc、PythonのDocstringsなど）によって異なります。
ドキュメントをコードと同期させるにはどうすればよいですか？
各コミットで実行されるCIパイプラインで���動ドキュメント生成をセットアップします。また、ドキュメントリントツールを使用して、デプロイ前に不整合を検出することもできます。
このスキルはプライベートAPIまたは内部APIをドキュメント化できますか？
はい。このスキルは任意のAPIをドキュメント化できます。ただし、外部で共有する前に、機密性の高い内部URL、認証情報、または独自情報を削除するために、生成されたドキュメントをレビューしてください。

開発者の詳細

作成者

sickn33

ライセンス

MIT

リポジトリ

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/code-documentation-doc-generate

参照

main

ファイル構成

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md