SECURITY REVIEW
Not yet assessed
Review the original instructions and requested permissions before installing.
No security review is available for this catalog entry yet.
Generate JSDoc, README files, and API specifications from source code.
コードからドキュメント(JSDoc、README、API仕様等)を生成する
Review the original instructions and requested permissions before installing.
No security review is available for this catalog entry yet.
How clearly the skill guides your agent, how complete its workflow is, and how you can check the outcome.
No quality assessment is available for this catalog entry yet.
Original instructions from the publisher’s SKILL.md
# /doc - ドキュメント生成 コードからドキュメント(JSDoc、docstring、README、API仕様等)を生成します。 ## 引数 - `$ARGUMENTS` から対象ファイルパスまたはディレクトリを取得 ## 実行手順 ### 1. 対象の分析 - ファイルの場合: エクスポートされた関数/クラス/型を分析 - ディレクトリの場合: モジュール全体の構造を分析 - 既存ドキュメントの有無を確認 ### 2. ドキュメント生成の種類判定 | 対象 | 生成物 | | ----------------- | ------------------------------------------------- | | 関数/メソッド | JSDoc / docstring | | クラス/型 | JSDoc / docstring + 使用例 | | モジュール | README.md | | APIエンドポイント | API仕様(リクエスト/レスポンス) | | プロジェクト全体 | README.md(セットアップ、使い方、アーキテクチャ) | ### 3. ドキュメント生成 - 既存のドキュメントスタイルに合わせる - パラメータの型と説明 - 戻り値の型と説明 - 使用例(可能な場合) - エラーケース ### 4. 既存ドキュメントの更新 - 既にドキュメントがある場合は更新 - 新規の場合は作成 - バレルファイル等の更新 ## 注意事項 - 自明なコードには過度なドキュメントを付けない - パブリックAPIを優先 - ビジネスロジックの「なぜ」を説明する
Files included alongside SKILL.md in the publisher’s repository.