/document - フォーカスされたドキュメント生成

特定のコンポーネント、関数、API、機能に対してフォーカスされたドキュメントを生成します。このスキルはランタイムニュートラルで、Claude Code、OpenCode、Codex で動作します。

引数

/document [what to document] [format: inline/api/guide/external]

引数はファイルパス、関数名、機能領域、またはドキュメント作成対象の説明となります。オプションの形式ヒント (inline、api、guide、external) は出力スタイルを制御します。省略された場合、コンテキストから最適な形式を推測します。

動作フロー

分析: ターゲットコンポーネントの構造、インターフェース、機能を調査
特定: ドキュメント要件とターゲット対象者のコンテキストを決定
生成: 適切なドキュメント内容を作成
フォーマット: 一貫した構造と組織パターンを適用
統合: 既存プロジェクトドキュメントエコシステムとの互換性を確保

主要な動作:

API 抽出と使用パターン特定を含むコード構造分析
マルチフォーマットドキュメント生成 (インライン、外部、API リファレンス、ガイド)
一貫したフォーマットとクロスリファレンス統合
既存の規約に合わせたプロジェクト固有のドキュメントパターン

ツール連携

Read: コンポーネント分析と既存ドキュメント確認
Grep: リファレンス抽出とパターン特定
Write: 適切なフォーマットでのドキュメントファイル作成
Glob: マルチファイルドキュメントプロジェクトと組織
Bash: データモデルドキュメント作成用のデータベース構造分析

ドキュメント形式

インラインドキュメント

JSDoc、ドキュメント文字列、タイプスペック、またはインラインコメントをソースファイルに直接追加します。

ターゲットファイルを読み込む
ドキュメントが不足している関数、モジュール、タイプ、インターフェースを特定
パラメータタイプ、戻り値、副作用、使用パターンを分析
言語の規約に従ってドキュメントコメントを追加:
- JavaScript/TypeScript: @param、@returns、@example を含む JSDoc
- Elixir: @doc、@moduledoc、@spec タイプスペック
- Python: パラメータと戻り値の説明を含むドキュメント文字列
既存ドキュメントを保持 — 追加または拡張のみ、削除は不可

API ドキュメント

API、エンドポイント、またはパブリックインターフェース用のリファレンス資料を生成します。

ターゲット内のすべてのパブリックエンドポイント、関数、またはインターフェースを特定
リクエスト/レスポンススキーマ、パラメータ、戻り値の型を抽出
以下を含む構造化されたリファレンスを生成:
- エンドポイントまたは関数シグネチャ
- 型と制約を含むパラメータ説明
- 例を含むレスポンス形式
- エラーケースとステータスコード
- 現実的なデータを使用した使用例
指定された出力パスまたは docs/api/ に書き込み

ユーザーガイド

エンドユーザーまたは開発者向けのタスク指向ドキュメントを作成します。

機能のユーザー向け動作と一般的なワークフローを分析
ガイドとして構成:
- 概要と目的
- 前提条件
- ステップバイステップの使用手順
- 設定オプション
- 一般的なパターンと例
- トラブルシューティング
指定された出力パスまたは docs/guides/ に書き込み

外部ドキュメント

コンポーネントまたはライブラリ用のスタンドアロンドキュメントファイルを生成します。

コンポーネントのパブリック API、プロパティ/パラメータ、動作を分析
以下を含むドキュメントを生成:
- コンポーネント概要と目的
- 型とデフォルト値を含むプロパティ/パラメータ
- 使用例
- 統合パターン
- 関連するコンポーネントまたはモジュール
指定された出力パスまたはコンポーネントと同じ場所に書き込み

例

/document src/auth/login.js inline
# login.js のすべての関数に JSDoc コメントを追加

/document GraphQL API api
# すべてのエンドポイントを含む API リファレンスを docs/api/ に作成

/document payment module guide
# ワークフローと例を含むユーザーガイドを docs/guides/ に作成

/document React components external
# プロパティ、使用法、統合パターン付きの外部ドキュメントを生成

/document lib/my_app/accounts.ex inline
# Elixir モジュールに @doc、@moduledoc、@spec を追加

ルール

生成する前にプロジェクトの既存ドキュメント規約を読む
プロジェクトの既存ドキュメントスタイルと構造に合わせる
センシティブな実装詳細、シークレット、内部 URL は公開しない
既存ドキュメントを保持 — 置き換えではなく拡張する
現実的なデータを使用した実践的な例を含める
適切な場合は関連するコンポーネントとモジュールへのクロスリファレンスを含める

$ARGUMENTS

ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ

document

SKILL.md 本文