Claude How-To

日本語

English
Tiếng Việt
中文
Українська

日本語

English
Tiếng Việt
中文
Українська

Appearance

Claude How ToClaude How To

Documentation プラグイン ​

プロジェクトのドキュメント生成と保守を包括的に行うプラグイン。

機能 ​

✅ API ドキュメント生成 ✅ README の作成と更新 ✅ ドキュメント同期 ✅ コードコメントの改善 ✅ サンプルコード生成

インストール ​

bash
/plugin install documentation

同梱内容 ​

スラッシュコマンド ​

  • /generate-api-docs — API ドキュメントを生成
  • /generate-readme — README を作成または更新
  • /sync-docs — コード変更にドキュメントを同期
  • /validate-docs — ドキュメントを検証

サブエージェント ​

  • api-documenter — API ドキュメンテーションのスペシャリスト
  • code-commentator — コードコメントの改善
  • example-generator — コード例の作成

テンプレート ​

  • api-endpoint.md — API エンドポイントのドキュメントテンプレート
  • function-docs.md — 関数ドキュメントのテンプレート
  • adr-template.md — Architecture Decision Record（ADR）テンプレート

MCP サーバー ​

  • ドキュメント同期のための GitHub 連携

使い方 ​

API ドキュメントを生成 ​

/generate-api-docs

README を作成 ​

/generate-readme

ドキュメントを同期 ​

/sync-docs

ドキュメントを検証 ​

/validate-docs

必要要件 ​

  • Claude Code 1.0 以上
  • GitHub アクセス（任意）

ワークフロー例 ​

User: /generate-api-docs

Claude:
1. Scans all API endpoints in /src/api/
2. Delegates to api-documenter subagent
3. Extracts function signatures and JSDoc
4. Organizes by module/endpoint
5. Uses api-endpoint.md template
6. Generates comprehensive markdown docs
7. Includes curl, JavaScript, and Python examples

Result:
✅ API documentation generated
📄 Files created:
   - docs/api/users.md
   - docs/api/auth.md
   - docs/api/products.md
📊 Coverage: 23/23 endpoints documented

テンプレートの使い方 ​

API Endpoint テンプレート ​

REST API エンドポイントを完全な例つきでドキュメント化する。

Function Documentation テンプレート ​

個々の関数 / メソッドのドキュメント化に使う。

ADR テンプレート ​

アーキテクチャ判断のドキュメント化に使う。

設定 ​

ドキュメント同期用の GitHub トークンを設定する：

bash
export GITHUB_TOKEN="your_github_token"

ベストプラクティス ​

  • ドキュメントはコードの近くに置く
  • コード変更とともにドキュメントも更新する
  • 実用的な例を含める
  • 定期的に検証する
  • 一貫性のためにテンプレートを使う

最終更新: 2026 年 4 月 24 日 Claude Code バージョン: 2.1.119 出典: