code-documenter

Generates and validates technical documentation across docstrings, API specs, and developer guides.

jeffallan/claude-skills|Updated Apr 8, 2026

Works with

Claude CodeCursorClineWindsurfCodexGoose

What it does

Supports multiple docstring formats (Google, NumPy, Sphinx for Python; JSDoc for TypeScript) and API specification standards (OpenAPI, AsyncAPI, gRPC)
Includes validation workflows for each format: doctest/pytest for Python, TypeScript compilation checks, and Redocly linting for OpenAPI specs
Covers inline code documentation, interactive API portals, documentation site generation, and

Repository

jeffallan/claude-skills

Last updated

Apr 8, 2026

Installation Guide

Select your AI agent

How to use code-documenter on Cursor

AI-first code editor with Composer

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

›Cursor installed and configured on your machine
›Node.js 16+ with npm — verify with node --version
›Active project directory where you want to add code-documenter

Run the install command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/jeffallan/claude-skills --skill code-documenter

Fetches code-documenter from jeffallan/claude-skills and configures it for Cursor.

Select Cursor when prompted

The CLI shows a list of agents. Use arrow keys and space to select Cursor:

◆ Which agents do you want to install to?

│

│ ── Universal (.agents/skills) ────────────────

│ · Cline · Codex · Goose · Windsurf

│ ●Cursor(selected)

│ · Cursor · Aider · Continue

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/code-documenter

Restart Cursor to activate code-documenter. Access via /code-documenter in your agent's command palette.

⚠

Security Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.

›View source on GitHub ›Skills CLI docs ›About Cursor ›What are agent skills?

Documentation

List & Monetize Your Skill

Submit your Claude Code skill and start earning

Get started →

Use Cases

Task Automation & Efficiency

Automate repetitive workflows and reduce manual effort

Example

Generate reports, summarize documents, draft communications

✓

Save 3-5 hours per week on routine tasks

Knowledge Enhancement

Learn new skills, understand complex topics, get expert guidance

Example

Explain concepts, provide examples, suggest learning resources

✓

Accelerate learning and skill development by 2x

Quality Improvement

Enhance output quality through reviews, suggestions, and refinements

Example

Review drafts, suggest improvements, catch errors

✓

Improve work quality by 30-40% with less effort

Core Workflow

Discover - Ask for format preference and exclusions

Detect - Identify language and framework

Analyze - Find undocumented code

Document - Apply consistent format

Validate - Test all code examples compile/run:

Python: python -m doctest file.py for doctest blocks; pytest --doctest-modules for module-wide checks
TypeScript/JavaScript: tsc --noEmit to confirm typed examples compile
OpenAPI: validate spec with npx @redocly/cli lint openapi.yaml
If validation fails: fix examples and re-validate before proceeding to the Report step

Report - Generate coverage summary

Quick-Reference Examples

Google-style Docstring (Python)

def fetch_user(user_id: int, active_only: bool = True) -> dict: """Fetch a single user record by ID. Args: user_id: Unique identifier for the user. active_only: When True, raise an error for inactive users. Returns: A dict containing user fields (id, name, email, created_at). Raises: ValueError: If user_id is not a positive integer. UserNotFoundError: If no matching user exists. """

NumPy-style Docstring (Python)

def compute_similarity(vec_a: np.ndarray, vec_b: np.ndarray) -> float: """Compute cosine similarity between two vectors. Parameters ---------- vec_a : np.ndarray First input vector, shape (n,). vec_b : np.ndarray Second input vector, shape (n,). Returns ------- float Cosine similarity in the range [-1, 1]. Raises ------ ValueError If vectors have different lengths. """

JSDoc (TypeScript)

/** * Fetches a paginated list of products from the catalog. * * @param {string} categoryId - The category to filter by. * @param {number} [page=1] - Page number (1-indexed). * @param {number} [limit=20] - Maximum items per page. * @returns {Promise<ProductPage>} Resolves to a page of product records. * @throws {NotFoundError} If the category does not exist. * * @example * const page = await fetchProducts('electronics', 2, 10); * console.log(page.items); */ async function fetchProducts( categoryId: string, page = 1, limit = 20 ): Promise<ProductPage> { ... }

Reference Guide

Load detailed guidance based on context:

Topic

Reference

Load When

Python Docstrings

references/python-docstrings.md

Google, NumPy, Sphinx styles

TypeScript JSDoc

references/typescript-jsdoc.md

JSDoc patterns, TypeScript

FastAPI/Django API

references/api-docs-fastapi-django.md

Python API documentation

NestJS/Express API

references/api-docs-nestjs-express.md

Node.js API documentation

Coverage Reports

references/coverage-reports.md

Generating documentation reports

Documentation Systems

references/documentation-systems.md

Doc sites, static generators, search, testing

Interactive API Docs

references/interactive-api-docs.md

OpenAPI 3.1, portals, GraphQL, WebSocket, gRPC, SDKs

User Guides & Tutorials

references/user-guides-tutorials.md

Getting started, tutorials, troubleshooting, FAQs

Constraints

MUST DO

Ask for format preference before starting

Detect framework for correct API doc strategy

Document all public functions/classes

Include parameter types and descriptions

Document exceptions/errors

Test code examples in documentation

Generate coverage report

MUST NOT DO

Assume docstring format without asking

Apply wrong API doc strategy for framework

Write inaccurate or untested documentation

Skip error documentation

Document obvious getters/setters verbosely

Create documentation that's hard to maintain

code-documenter

What it does

Category

Repository

Last updated

Installation Guide

How to use code-documenter on Cursor

Prerequisites

Run the install command

Select Cursor when prompted

Verify installation

Security Notice

Documentation

List & Monetize Your Skill

Use Cases

Task Automation & Efficiency

Knowledge Enhancement

Quality Improvement

Install Skill

Code Documenter

When to Use This Skill

Core Workflow

Quick-Reference Examples

Google-style Docstring (Python)

NumPy-style Docstring (Python)

JSDoc (TypeScript)

Reference Guide

Constraints

MUST DO

MUST NOT DO

Output Formats

Knowledge Reference

Implementation Guide

Best Practices

When to Use This

Learning Path

Related Skills

nestjs-expert

flutter-expert

embedded-systems

fastapi-expert

spec-miner

django-expert

Reviews

Discussion