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.zipInstalls 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仕様等）を生成するKey capabilities
- →Analyze exported functions, classes, or types from a file
- →Analyze module structure from a directory
- →Generate JSDoc or docstring for functions/methods
- →Generate README.md for modules or entire projects
- →Generate API specifications for API endpoints
How it works
This skill generates documentation from code by analyzing the target file or directory, determining the type of documentation needed, and then creating it. It considers existing documentation styles and includes details like parameter types and usage examples.
Inputs & outputs
When to use doc
- →Generate jsdoc for functions
- →Create project readme
- →Document api endpoints
About this skill
/doc - ドキュメント生成
コードからドキュメント（JSDoc、docstring、README、API仕様等）を生成します。
引数
$ARGUMENTSから対象ファイルパスまたはディレクトリを取得
実行手順
1. 対象の分析
- ファイルの場合: エクスポートされた関数/クラス/型を分析
- ディレクトリの場合: モジュール全体の構造を分析
- 既存ドキュメントの有無を確認
2. ドキュメント生成の種類判定
| 対象 | 生成物 |
|---|---|
| 関数/メソッド | JSDoc / docstring |
| クラス/型 | JSDoc / docstring + 使用例 |
| モジュール | README.md |
| APIエンドポイント | API仕様（リクエスト/レスポンス） |
| プロジェクト全体 | README.md（セットアップ、使い方、アーキテクチャ） |
3. ドキュメント生成
- 既存のドキュメントスタイルに合わせる
- パラメータの型と説明
- 戻り値の型と説明
- 使用例（可能な場合）
- エラーケース
4. 既存ドキュメントの更新
- 既にドキュメントがある場合は更新
- 新規の場合は作成
- バレルファイル等の更新
注意事項
- 自明なコードには過度なドキュメントを付けない
- パブリックAPIを優先
- ビジネスロジックの「なぜ」を説明する
When not to use it
- →The task is to generate code from documentation
- →The task is about database schema evolution without API surface impact
Limitations
- →Do not over-document obvious code
- →Prioritize public APIs for documentation
- →Explain the 'why' of business logic
How it compares
This workflow automates the creation of various documentation types directly from code, ensuring consistency and reducing manual effort compared to writing documentation from scratch.
Compared to similar skills
doc side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| doc (this skill) | 0 | 5mo | No flags | Beginner |
| readme-generator | 3 | 9mo | Review | Beginner |
| doc-author | 1 | 6mo | No flags | Intermediate |
| repo-source-code-document | 1 | 5mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
readme-generator
aws-samples
This skill should be used when users want to create or improve README.md files for their projects. It generates professional documentation following the Deep Insight/Strands SDK style - comprehensive yet focused, with clear structure and practical examples.
doc-author
mintlify
Write and maintain documentation autonomously. Use when assigned to create, update, or improve documentation without direct human oversight. Always opens PRs for review. Built by Mintlify.
repo-source-code-document
open-circle
Write JSDoc comments and inline documentation for Valibot library source code in /library/src/. Use when documenting schemas, actions, methods, or utilities. Covers interface documentation, function overloads, purity annotations, inline comment patterns, and terminology consistency.
docs
Rune-kit
Auto-generate and maintain project documentation. Creates README, API docs, architecture docs, changelogs, and keeps them in sync with code changes. The \"docs are never outdated\" skill.
korean-skill-creator
clwmfksek
한글 기반 클로드 스킬 자동 생성 도구. 사용자가 "클로드 스킬을 만들어줘" 또는 "[요구사항] 스킬 만들어줘"라고 요청할 때 사용. Progressive disclosure 원칙을 따르는 한글 문서 구조(SKILL.md + references/)를 자동으로 생성하고, 실전 예시를 포함한 일관성 있는 스킬 템플릿을 제공.
skill-forge
WilliamSaysX
Automated skill creation workshop with intelligent source detection, smart path management, and end-to-end workflow automation. This skill should be used when users want to create a new skill or convert external resources (GitHub repositories, online documentation, or local directories) into a skill. Automatically fetches, organizes, and packages skills with proactive cleanup management.