code-documenter

Generate consistent documentation from code and API surfaces.

Updated Feb 11, 2026
One-click install
npx skills add https://github.com/lamb92009/claude-skills --skill code-documenter-lamb92009
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/lamb92009/claude-skills/tree/main/code-documenter
Command: npx skills add https://github.com/lamb92009/claude-skills --skill code-documenter-lamb92009

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation inconsistencies across codebases hinder maintainability and onboarding. This Skill provides a structured approach to generating consistent docstrings, API specs, and developer guides from code.

Core Features & Use Cases

  • Automated docstring extraction: Converts inline documentation into standardized formats.
  • OpenAPI/Swagger generation: Derives API specs from type hints and annotations.
  • Documentation portals: Produces navigable docs sites (Docusaurus/MkDocs/VitePress) with cross-references.
  • Use Case: Maintain uniform public docs across multiple libraries and languages with minimal manual edits.

Quick Start

Run the tool on your codebase to generate comprehensive docs for a selected module.

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 docstrings and API documentation from my codebase?

Automated documentation generation turns code and inline docstrings into consistent, readable docs across Python, TypeScript, and other languages by applying standardized sections and structured frontmatter.

Can I generate an OpenAPI spec from type hints and annotations automatically?

Yes, OpenAPI generation derives API specs directly from existing type hints and code annotations, enforcing structured frontmatter and cross-reference validation to ensure accuracy.

What is the best way to build a navigable documentation portal from multiple libraries?

Documentation portals produce navigable docs sites using frameworks like Docusaurus, MkDocs, or VitePress, maintaining uniform public docs across multiple libraries with minimal manual edits.

Does this documentation tool work with both Python and TypeScript codebases?

Yes, documentation generation applies to Python, TypeScript, and other languages for libraries, services, and SDKs, standardizing inline docstrings and developer guides across polyglot codebases.

How do cross-references get validated when generating developer guides?

Cross-reference validation ensures accuracy and discoverability by checking structured frontmatter and standardized sections against the actual API surface during documentation generation.

Why are my documentation sites inconsistent across different libraries and languages?

Documentation inconsistencies hinder maintainability, but applying structured frontmatter, standardized sections, and cross-reference validation ensures uniform public docs across multiple libraries and languages.