code-documenter

Generate docstrings, OpenAPI specs, and documentation coverage reports.

10.9k|1.0k|Updated Oct 20, 2025
One-click install
npx skills add https://github.com/Jeffallan/claude-skills --skill code-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/Jeffallan/claude-skills/tree/main/skills/code-documenter
Command: npx skills add https://github.com/Jeffallan/claude-skills --skill code-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps write inline docstrings, API docs, and tutorials, ensuring consistent documentation across languages and frameworks to accelerate developer onboarding and reduce support time.

Core Features & Use Cases

  • Docstrings & API Docs: Produce structured docstrings (Python, TypeScript, etc.) and OpenAPI specs.
  • Documentation Portals: Create static docs sites (Docsify, MkDocs, Docusaurus) and portal configurations.
  • Guides & Tutorials: Generate getting started guides and hands-on tutorials with best practices.
  • Evaluation & Coverage: Produce documentation coverage reports and testing plans.

Quick Start

Provide a function/class docstring in Python or TypeScript and generate an OpenAPI spec for a small REST endpoint.

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 from my REST API code?

OpenAPI specs document REST APIs by defining endpoints, parameters, and responses in a machine-readable format. This Skill detects your framework and generates structured OpenAPI/Swagger specs directly from your code, eliminating manual spec writing and keeping documentation in sync with implementation.

Can I automatically create docstrings for Python and TypeScript functions?

Yes. This Skill generates consistent inline docstrings across Python, TypeScript, and Node.js by analyzing function signatures, parameter types, and return values. It produces documentation that includes parameter descriptions, exception handling, and executable examples.

What's the best way to document API code across multiple languages?

Standardizing documentation across Python, TypeScript, and Node.js requires a unified approach to docstrings, parameter types, and examples. This Skill applies consistent documentation patterns across these ecosystems, producing portal-ready outputs and coverage reports.

How do I measure documentation coverage for my codebase?

Documentation coverage reports identify which functions, classes, and endpoints lack complete documentation. This Skill generates coverage metrics and testing plans to track documentation gaps and ensure all public APIs are thoroughly documented.

Can I create static documentation sites from my API code?

Yes. This Skill generates documentation artifacts compatible with static site generators like Docsify, MkDocs, and Docusaurus, complete with tutorials, getting started guides, and portal configurations ready for deployment.

Do I need to write JSDoc manually for TypeScript projects?

No. This Skill automatically generates JSDoc-formatted documentation for TypeScript and JavaScript, detecting your framework and structuring docstrings with parameter types, descriptions, exceptions, and usage examples.