Generate docs

Skill Imran-ml/claude-skills/.claude/skills/generate-docs

Reusable Claude Code configuration repository with skills, subagents, hooks, MCP setup, and examples for bootstrapping new projects.

Install

npx -y skills add Imran-ml/claude-skills --skill generate-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Use this skill to generate, update, or improve documentation. Triggered by "write docs", "generate documentation", "update README", "document this code".

SKILL.md

2.3 KB, 484 tokens by cl100k_base, as published. Nobody here has run it

Documentation Generator

Generate clear, accurate documentation for the specified code.

Target

$ARGUMENTS

!ls -la $ARGUMENTS 2>/dev/null || echo "Scanning for files..."

Instructions

Read all relevant source files for the target
Identify what needs documentation:
- Public functions, classes, and methods
- Module purpose and exports
- Configuration options
- Usage examples
Choose the appropriate format:
- JSDoc/TSDoc for TypeScript/JavaScript functions
- docstring for Python
- godoc for Go
- README.md for modules/repos
- API.md for REST API endpoints
Write documentation that includes:
- Purpose — what it does (1-2 sentences)
- Parameters — name, type, description, whether required
- Returns — type and description
- Throws — what errors can occur
- Example — minimal working example
- Notes — gotchas, performance notes, deprecations

JSDoc Example

/**
 * Fetches a paginated list of users matching the given filters.
 *
 * @param filters - Search criteria to narrow results
 * @param filters.role - Optional role filter ('admin' | 'user' | 'guest')
 * @param filters.active - When true, returns only active accounts
 * @param page - 1-based page number (default: 1)
 * @param pageSize - Results per page, max 100 (default: 20)
 * @returns Paginated result with users and total count
 * @throws {ValidationError} When pageSize exceeds 100
 * @throws {DatabaseError} When the query times out
 *
 * @example
 * const result = await getUsers({ role: 'admin', active: true });
 * console.log(result.total, result.users);
 */

Rules

Do NOT fabricate behavior — only document what the code actually does
Keep examples minimal but runnable
If the code is confusing, note it and suggest a refactor
Update existing docs rather than creating duplicates
For READMEs: include install, usage, configuration, and contributing sections

$ARGUMENTS