agentskills.codes

コードからドキュメント(JSDoc、README、API仕様等)を生成する

Install

mkdir -p .claude/skills/doc-sei-yukinari && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/15857" && unzip -o skill.zip -d .claude/skills/doc-sei-yukinari && rm skill.zip

Installs to .claude/skills/doc-sei-yukinari

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

コードからドキュメント(JSDoc、README、API仕様等)を生成する
37 charsno explicit “when” trigger

About this skill

/doc - ドキュメント生成

コードからドキュメント(JSDoc、docstring、README、API仕様等)を生成します。

引数

  • $ARGUMENTS から対象ファイルパスまたはディレクトリを取得

実行手順

1. 対象の分析

  • ファイルの場合: エクスポートされた関数/クラス/型を分析
  • ディレクトリの場合: モジュール全体の構造を分析
  • 既存ドキュメントの有無を確認

2. ドキュメント生成の種類判定

対象生成物
関数/メソッドJSDoc / docstring
クラス/型JSDoc / docstring + 使用例
モジュールREADME.md
APIエンドポイントAPI仕様(リクエスト/レスポンス)
プロジェクト全体README.md(セットアップ、使い方、アーキテクチャ)

3. ドキュメント生成

  • 既存のドキュメントスタイルに合わせる
  • パラメータの型と説明
  • 戻り値の型と説明
  • 使用例(可能な場合)
  • エラーケース

4. 既存ドキュメントの更新

  • 既にドキュメントがある場合は更新
  • 新規の場合は作成
  • バレルファイル等の更新

注意事項

  • 自明なコードには過度なドキュメントを付けない
  • パブリックAPIを優先
  • ビジネスロジックの「なぜ」を説明する

Search skills

Search the agent skills registry