ドキュメント自動生成
ドキュメント入門
指定されたコードファイルやモジュールを分析し、関数シグネチャ、パラメータ説明、戻り値、使用例を含むドキュメントを自動で生成します。
トリガー
/docs [file]使用頻度週1-2回
ドキュメント作成が溜まっているOSSメンテナーなら？ /docs src/utilsで関数シグネチャからサンプルまで自動生成
ドキュメント自動化可読性
動作フロー
/docs [ファイル] 実行
↓
フェーズ1: 3つの分析を並列実行
sig-parse
シグネチャのパース
type-extract
型情報の抽出
usage-find
使用パターンの収集
↓
Markdownドキュメント生成
↓
✓ パラメータテーブル + 戻り値 + 使用例
スキルコード
# Doc Generator Skill
## Trigger: /docs [file or directory]
When invoked:
1. Analyze target code:
- Exported functions/classes
- Parameter types and defaults
- Return types
- Usage patterns in codebase
2. Generate documentation:
- Function signatures with descriptions
- Parameter table with types and defaults
- Return value description
- Usage examples from actual codebase
3. Format:
## functionName(params)
Description of what this function does.
### Parameters
| Name | Type | Default | Description |
|--------|--------|---------|--------------|
| param1 | string | - | What it does |
### Returns
`ReturnType` — Description
### Example
```typescript
const result = functionName("input");
```
コピーしてCLAUDE.mdに貼り付ければ、すぐに使えます。
ドキュメント自動生成 の仕組み
Doc Generatorはソースコードファイルを読み取り、関数シグネチャ、クラス構造、インラインコメントを抽出した上で、パラメータ説明、戻り値の型、使用例を含むフォーマット済みAPIドキュメントを生成します。
ドキュメント自動生成 が力を発揮する場面
ドキュメントなしで成長した既存コードベースをドキュメント化する必要があるときに非常に有効です。実装パターンからコードの意図を理解し、APIユーザーに実際に役立つドキュメントを生成します。
主な強み
- コメントだけでなくコード構造からドキュメントを抽出
- 実際の関数シグネチャに基づく使用例を生成
- 複数の出力形式に対応（Markdown、JSDocなど）
- 実行するたびにコード変更とドキュメントを同期