skills.rest
Estom
EstomCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

code-documenter

Generate framework-aware documentation with docstrings, OpenAPI specs, and doc sites.

Updated Mar 17, 2026
Search Tags:#documentation#openapi#jsdoc#docstrings#api-docs#docsite#coverage-reports
One-click install
npx skills add https://github.com/Estom/aiflex --skill code-documenter-estom
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/Estom/aiflex/tree/main/skills-repo/Jeffallan-skills/code-documenter
Command: npx skills add https://github.com/Estom/aiflex --skill code-documenter-estom

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Many codebases lack consistent, tested, and framework-aware documentation, which makes APIs hard to adopt, increases onboarding time, and creates maintenance debt. This Skill addresses inconsistent or missing docstrings, incomplete OpenAPI specifications, and the overhead of building and configuring documentation sites.

Core Features & Use Cases

  • Language & Framework Detection: Automatically detect Python, TypeScript, FastAPI, Django, NestJS, Express, GraphQL, and gRPC patterns to choose the correct documentation strategy.
  • Docstring & API Spec Generation: Add consistent docstrings (Google/NumPy/Sphinx), produce OpenAPI/Swagger specs, and generate JSDoc for TypeScript projects.
  • Doc Site & Portal Setup: Create site structure and configuration for Docusaurus, MkDocs, or VitePress and prepare Swagger UI/Redoc/Stoplight integrations.
  • Validation & Coverage: Test code examples, validate generated specs, and produce documentation coverage reports and checklists.
  • Use Case Examples: Add Google-style docstrings to a Python library, generate OpenAPI for a FastAPI service, and scaffold a Docusaurus site with API pages.

Quick Start

Document the public functions in src/utils.py using Google-style docstrings, generate an OpenAPI spec for any REST endpoints, and produce a documentation 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 generate OpenAPI specs for a FastAPI or NestJS codebase?▼

Generating OpenAPI specs for FastAPI or NestJS involves detecting framework-specific REST endpoints and producing validated OpenAPI-compatible specifications. It also prepares Swagger UI, Redoc, or Stoplight integrations for visualizing the API documentation.

What's the best way to add consistent docstrings to a Python library?▼

Adding consistent docstrings to a Python library requires enforcing a chosen style like Google, NumPy, or Sphinx. This Skill automatically detects Python patterns and applies your selected docstring style across the codebase while producing a documentation coverage report.

Can I scaffold a documentation site for an Express or Django project?▼

Scaffolding a documentation site for Express or Django projects is fully supported. This Skill creates site structure and configuration for Docusaurus, MkDocs, or VitePress, preparing static documentation portals with API pages tailored to your framework.

Does documentation generation work with GraphQL and gRPC patterns?▼

Documentation generation does work with GraphQL and gRPC patterns. The Skill automatically detects these protocols alongside Python and TypeScript to choose the correct documentation strategy, producing framework-aware API specifications and docstrings.

How do I produce a documentation coverage report for TypeScript code?▼

Producing a documentation coverage report for TypeScript code involves generating JSDoc annotations and validating tested code examples. It outputs a comprehensive checklist and coverage report highlighting undocumented areas across your TypeScript project.

Related Skills

Explore More Software Engineering Skills→
crycriMcrycriM

codebase-skeleton

Compress source code repositories into compact skeletons with imports and signatures.

Community
Intermediate
docaohieu2808docaohieu2808

mintlify

Build and deploy documentation sites with Mintlify, MDX, and OpenAPI.

Community
Intermediate
klhklh
9

code-documenter

Generate and validate docstrings, JSDoc, and OpenAPI specs for Python, TypeScript, and Node.js projects.

Community
Advanced
acme-skunkworksacme-skunkworks

documentation-and-adrs

Automate creation and management of ADRs and project documentation.

Official
Advanced