skills.rest
filippolmt
filippolmtCOMMUNITY
Explore all skills by this author →
GitHub

code-documenter

Generates and validates docstrings, OpenAPI specs, JSDoc annotations, and developer guides.

1|Updated Jul 2, 2026
Search Tags:#documentation#openapi#jsdoc#docstrings#api docs#swagger#tutorials
One-click install
npx skills add https://github.com/filippolmt/skills --skill code-documenter-filippolmt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/filippolmt/skills/tree/main/skills/code-documenter
Command: npx skills add https://github.com/filippolmt/skills --skill code-documenter-filippolmt

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Codebases often ship with missing, inconsistent, or inaccurate documentation, forcing developers to reverse-engineer APIs and functions. This Skill automates the creation, formatting, and validation of technical documentation across languages and frameworks. ## Core Features & Use Cases - Inline Documentation: Generates Google, NumPy, and Sphinx style Python docstrings plus TypeScript JSDoc annotations with parameters, returns, and exceptions. - API Documentation: Produces OpenAPI 3.0/3.1 specs and framework-specific docs for FastAPI, Django REST Framework, NestJS, and Express, plus GraphQL, AsyncAPI, and gRPC coverage. - Doc Sites & Guides: Configures documentation portals with Docusaurus, MkDocs, or VitePress, and writes tutorials, troubleshooting guides, and FAQs. - Use Case: Point it at an undocumented NestJS service and receive fully decorated controllers with @ApiOperation and @ApiResponse annotations, a validated Swagger UI setup, and a coverage report showing before/after documentation percentages. ## Quick Start Ask the assistant to document all public functions in your project using Google-style docstrings and generate a coverage report.

Frequently Asked Questions about code-documenter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add docstrings to Python functions automatically?▼

Specify your preferred style (Google, NumPy, or Sphinx) and the Skill analyzes undocumented functions, then generates docstrings with Args, Returns, and Raises sections. It validates doctest examples with python -m doctest before reporting coverage.

How to generate OpenAPI documentation for a FastAPI project?▼

FastAPI auto-generates OpenAPI from type hints and docstrings, so the Skill enriches endpoints with summary, tags, response_model, and Field examples. For Django REST Framework it uses drf-spectacular's @extend_schema decorators instead.

What is the difference between Google and NumPy docstring styles?▼

Google style uses compact Args: and Returns: blocks, while NumPy style uses underlined Parameters and Returns section headers with explicit type lines. Google is more readable for most projects; NumPy suits scientific computing codebases.

Does it support NestJS and Express API documentation?▼

Yes. NestJS uses @nestjs/swagger decorators like @ApiOperation, @ApiResponse, and @ApiProperty on controllers and DTOs. Express uses swagger-jsdoc with @swagger JSDoc comment blocks served through swagger-ui-express.

How are code examples in documentation validated?▼

Python examples run through doctest or pytest --doctest-modules, TypeScript examples are checked with tsc --noEmit, and OpenAPI specs are linted with npx @redocly/cli lint. Failures are fixed and re-validated before the final report.

Which documentation site generator should I use?▼

Docusaurus fits React projects needing versioning, MkDocs with Material theme suits Python projects, and VitePress works best for Vue projects with fast builds. The Skill configures the chosen generator including search and navigation.

Related Skills

Explore More Software Engineering Skills→
mattbobambrosemattbobambrose
1

add-docs

Add inline documentation comments to undocumented public symbols in source files across a repository.

Community
Intermediate
5onyy5onyy

code-documentation-doc-generate

Generate API docs, architecture diagrams, and user guides from source code.

Community
Intermediate
jankneumannjankneumann
4

update-specs

Detect and update OpenSpec documents to match implemented code.

Community
Intermediate
rodmena-limitedrodmena-limited
3

moai-docs-generation

Generate documentation from source code and API annotations using Sphinx, MkDocs, TypeDoc, and Nextra.

Official
Advanced