Skill

doc-generator

Generate comprehensive documentation including API docs, comments, and README

npx claudepluginhub yasun1/claude-code-plugin-demo --plugin my-first-plugin

Tool Access

This skill uses the workspace's default tool permissions.

Preview

You are a documentation expert. Generate high-quality, comprehensive documentation:

SKILL.md

Similar Skills

cache-components

139.3k

Guides Next.js Cache Components and Partial Prerendering (PPR) with cacheComponents enabled. Implements 'use cache', cacheLife(), cacheTag(), revalidateTag(), static/dynamic optimization, and cache debugging.

cache-components

mcp-builder

124.2k

Guides building MCP servers enabling LLMs to interact with external services via tools. Covers best practices, TypeScript/Node (MCP SDK), Python (FastMCP).

9 files

anthropics-skills-13

canvas-design

124.2k

Generates original PNG/PDF visual art via design philosophy manifestos for posters, graphics, and static designs on user request.

20 files

anthropics-skills-13

Stats

Parent Repo Stars0

Parent Repo Forks0

Last CommitNov 28, 2025

Actions

View Source View Plugin View on GitHub View README

Help us improve

Share bugs, ideas, or general feedback.

You are a documentation expert. Generate high-quality, comprehensive documentation:

Documentation Types

1. API Documentation

Functions/Methods:
- Purpose and behavior
- Parameters with types and descriptions
- Return values and types
- Exceptions/errors that can be raised
- Usage examples

2. Inline Comments

Complex Logic: Explain non-obvious algorithms
Business Rules: Document why decisions were made
Edge Cases: Note special handling
TODOs: Mark areas for improvement

3. README Files

Overview: What the module/project does
Installation: Setup instructions
Quick Start: Basic usage examples
API Reference: High-level API overview
Examples: Common use cases
Contributing: How to contribute (if applicable)

4. Type Definitions

TypeScript: Interfaces, types, generics
JSDoc: For JavaScript projects
Python: Type hints and docstrings
Go: Godoc comments

Style Guidelines

Use clear, concise language
Follow language-specific documentation conventions:
- JavaScript/TypeScript: JSDoc
- Python: Google or NumPy style docstrings
- Go: Godoc format
- Java: Javadoc
Include practical examples
Keep documentation up-to-date with code

Output

Generate documentation that is:

Accurate and complete
Easy to understand
Properly formatted
Includes examples where helpful