code-documenter

Generates docstrings, OpenAPI specs, JSDoc annotations, and developer guides for codebases.

Updated Mar 9, 2026
One-click install
npx skills add https://github.com/ArMaTeC/Redball --skill code-documenter-armatec
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/ArMaTeC/Redball/tree/main/.devin/skills/code-documenter
Command: npx skills add https://github.com/ArMaTeC/Redball --skill code-documenter-armatec

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing and maintaining accurate code documentation is time-consuming, and undocumented functions, APIs, and SDKs slow down onboarding and integration. This Skill automates the generation, formatting, and validation of technical documentation across languages and frameworks. ## Core Features & Use Cases - Inline Documentation: Generates Google, NumPy, and Sphinx-style Python docstrings and TypeScript JSDoc annotations with parameters, return types, exceptions, and examples. - 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 documentation. - Doc Sites & Guides: Configures documentation portals with Docusaurus, MkDocs, or VitePress, and writes getting-started guides, tutorials, troubleshooting pages, and FAQs. - Use Case: Point it at an undocumented NestJS service and receive fully decorated controllers and DTOs with @ApiOperation and @ApiProperty annotations, a validated OpenAPI spec, 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?▼

The Skill detects your Python code and applies Google, NumPy, or Sphinx-style docstrings covering parameters, return values, exceptions, and examples. It asks for your format preference first, then documents all public functions and validates examples with doctest.

How to generate OpenAPI documentation for a NestJS API?▼

NestJS requires explicit decorators from @nestjs/swagger. The Skill adds @ApiTags, @ApiOperation, @ApiResponse, and @ApiProperty annotations to controllers and DTOs, producing an OpenAPI spec served through Swagger UI.

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

Google style uses compact Args: and Returns: blocks, while NumPy style uses extended Parameters and Returns sections with type annotations on separate lines. Both document the same information; Google style is more concise for most projects.

Does FastAPI need manual OpenAPI documentation?▼

FastAPI auto-generates OpenAPI docs from type hints and docstrings, so the Skill focuses on enriching endpoints with summary, tags, response_model, and Field examples. Django REST Framework instead requires drf-spectacular with @extend_schema decorators.

How do I measure documentation coverage in my codebase?▼

The Skill generates a coverage report comparing documented versus total functions, classes, and API endpoints before and after documentation. It also recommends tools like interrogate for Python and eslint-plugin-jsdoc for JavaScript to enforce coverage in CI.

Which static site generator should I use for API documentation?▼

Docusaurus suits React projects needing versioning, MkDocs with Material theme fits Python projects, and VitePress works best for Vue projects with fast builds. The Skill provides configuration templates for each including search and navigation setup.