skills.rest
klh
klhCOMMUNITY
Explore all skills by this author →
Website𝕏@klhougesenGitHub

code-documenter

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

9|Updated Apr 3, 2026
Search Tags:#documentation#openapi#jsdoc#docstrings#validate#api-docs#docs-site
One-click install
npx skills add https://github.com/klh/speedy-claude --skill code-documenter-klh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/klh/speedy-claude/tree/main/skills/code-documenter
Command: npx skills add https://github.com/klh/speedy-claude --skill code-documenter-klh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Many codebases lack consistent, accurate, and testable documentation, causing developer confusion, onboarding delays, and brittle examples that break in production. This Skill centralizes discovery, generation, and validation of docstrings, API specs, and documentation sites to save time and reduce errors.

Core Features & Use Cases

  • Docstring Generation: Add Google, NumPy, or Sphinx-style docstrings to Python functions and classes.
  • API Spec Authoring: Produce OpenAPI/Swagger specs for FastAPI, Django, NestJS, and Express projects.
  • JSDoc & TypeScript: Create and standardize JSDoc comments, DTO annotations, and interface docs.
  • Validation & Testing: Run doctest, tsc --noEmit, and OpenAPI linting to ensure examples compile and specs are valid.
  • Doc Sites & Guides: Scaffold documentation sites (Docusaurus, MkDocs, VitePress) and author getting-started guides and tutorials.
  • Reporting: Generate documentation coverage reports and checklists to drive CI integration.

Quick Start

Use the code-documenter skill to add Google-style docstrings to all public Python functions in src/, validate examples, 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 consistent Python docstrings and validate the examples inside them?▼

Generate Python docstrings by applying Google, NumPy, or Sphinx styles to functions and classes, then validate documentation examples by running doctest to ensure they compile and execute correctly.

Can I produce OpenAPI specs for FastAPI and Express projects automatically from source code?▼

Yes, you can produce OpenAPI and Swagger specifications for FastAPI, Django, NestJS, and Express projects by authoring and formatting API docs directly from source code definitions.

What's the best way to standardize JSDoc annotations and TypeScript DTO documentation across a Node.js codebase?▼

Standardize JSDoc and TypeScript documentation by creating consistent JSDoc comments, DTO annotations, and interface docs, then validating them with tsc --noEmit and linter tooling.

Does this documentation generation approach work with static site generators like Docusaurus and MkDocs?▼

Yes, this approach scaffolds documentation sites using Docusaurus, MkDocs, and VitePress, and authors getting-started guides and tutorials alongside the generated API documentation.

How do I measure documentation coverage and integrate it into CI pipelines?▼

Measure documentation completeness by generating coverage reports and checklists that identify undocumented functions, classes, and API endpoints to drive continuous integration checks.

Related Skills

Explore More Software Engineering Skills→
zero-rehqzero-rehq

api-documentation-generator

Generate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.

Community
Intermediate
alexander-danilenkoalexander-danilenko
14

code-documenter

Generate docstrings, OpenAPI specs, and documentation sites for Python and TypeScript.

Community
Advanced
VXerysVXerys

code-documenter

Generate and validate docstrings, OpenAPI specs, and JSDoc annotations.

Community
Advanced
EstomEstom

code-documenter

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

Community
Advanced