code-documenter

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

Updated Feb 24, 2026
One-click install
npx skills add https://github.com/marketiv-id/marketiv-web --skill code-documenter-marketiv-id
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/marketiv-id/marketiv-web/tree/main/00_BACKEND/.agents/skills/code-documenter
Command: npx skills add https://github.com/marketiv-id/marketiv-web --skill code-documenter-marketiv-id

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing and maintaining accurate technical documentation is time-consuming, and undocumented code slows onboarding and API adoption. This Skill automates the creation of docstrings, API specifications, documentation sites, and user guides while validating that every code example actually compiles or runs. ## Core Features & Use Cases - Inline Documentation: Generates Google, NumPy, or Sphinx style Python docstrings and JSDoc annotations for TypeScript/JavaScript functions, classes, and interfaces. - 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 tutorials, troubleshooting guides, and FAQs. - Use Case: Point it at an undocumented NestJS backend and receive fully decorated controllers with @ApiOperation/@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?

Use this Skill to analyze undocumented Python code and generate docstrings in Google, NumPy, or Sphinx style. It documents parameters, return values, and raised exceptions, then validates examples with doctest or pytest --doctest-modules.

How to generate OpenAPI documentation for a NestJS API?

NestJS requires explicit @nestjs/swagger decorators like @ApiOperation, @ApiResponse, and @ApiProperty on controllers and DTOs. The Skill applies these decorators across your endpoints and produces a Swagger UI served from your application.

What is the difference between FastAPI and Express API documentation?

FastAPI auto-generates OpenAPI docs from type hints and docstrings with minimal effort. Express requires manual swagger-jsdoc comment blocks defining paths, schemas, and responses, which are then served through swagger-ui-express.

Does it support documentation for GraphQL or WebSocket APIs?

Yes, it covers GraphQL schema documentation with description strings, AsyncAPI specs for WebSocket channels, and protobuf comments for gRPC services. Each protocol gets format-appropriate interactive documentation.

Which static site generator should I use for a documentation portal?

Docusaurus suits React projects needing versioning, MkDocs with Material theme fits Python projects, and VitePress works best for Vue stacks. The Skill configures navigation, search, and build settings for your chosen generator.

Why do code examples in documentation need validation?

Untested examples frequently break as APIs evolve, eroding developer trust. The Skill runs doctest for Python, tsc --noEmit for TypeScript, and Redocly lint for OpenAPI specs, fixing failures before reporting coverage.