code-documenter

Generate docstrings, OpenAPI specs, and documentation portals from source code.

Updated Feb 1, 2026

Search Tags:#documentation #OpenAPI #docstrings #Swagger #JSDoc #documentation-sites

Ready to run

npx skills add https://github.com/Agentic-Assets/Agent-Skills --skill code-documenter-agentic-assets

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/Agentic-Assets/Agent-Skills/tree/main/skills/code-documenter
Command: npx skills add https://github.com/Agentic-Assets/Agent-Skills --skill code-documenter-agentic-assets

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Manually writing and maintaining consistent documentation for codebases is tedious and error-prone. This skill automates inline docstrings, OpenAPI/Swagger specs, and developer guides to ensure up-to-date, readable docs.

Core Features & Use Cases

Inline documentation: Generate and enforce docstrings for functions and classes across languages.
API documentation: Create OpenAPI/Swagger specs and interactive API docs.
Documentation portals: Produce complete documentation sites (e.g., Docusaurus, MkDocs) and user guides from code and references.
Use Case: When shipping a software library, auto-generate consistent docs for onboarding, troubleshooting, and API reference.

Quick Start

Process your project with Code Documenter to generate comprehensive docs from code and references.

Frequently Asked Questions about code-documenter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automate generating OpenAPI and Swagger specs from source code?▼

Automate OpenAPI and Swagger spec generation by processing source code and inline docs to extract metadata. This enforces frontmatter-driven extraction and language-aware formatting to produce up-to-date, readable API documentation automatically.

Can I generate docstrings for both Python and TypeScript functions automatically?▼

Yes, you can generate and enforce docstrings for functions and classes across Python and TypeScript. The process applies language-aware formatting to ensure inline documentation remains consistent across multi-language projects.

What is the best way to build a documentation portal from existing code?▼

The best way to build a documentation portal is generating complete sites like Docusaurus or MkDocs directly from code and references. This transforms source code and API specs into user guides for onboarding and troubleshooting.

Does this documentation approach work for multi-language software libraries?▼

Yes, this approach works for multi-language software libraries by extracting metadata and applying formatting rules specific to each language. It generates consistent reference materials across diverse codebases without manual intervention.

How do I maintain inline documentation when shipping a new library version?▼

Maintain inline documentation by running automated generation against your updated source code. This ensures docstrings, API specs, and developer guides reflect the latest changes without tedious, error-prone manual updates.

What are the limitations of automating code documentation generation?▼

Automating code documentation relies heavily on existing source code structure and inline docs for metadata extraction. If the codebase lacks clear patterns or frontmatter metadata, the generated reference materials may require manual refinement.