code-documenter

Generate technical documentation for Python and Node.js codebases and APIs.

2|Updated Apr 18, 2021
One-click install
npx skills add https://github.com/rabbicse/go-projects --skill code-documenter-rabbicse
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/rabbicse/go-projects/tree/main/projects/movie-ticket-booking/.claude/skills/code-documenter
Command: npx skills add https://github.com/rabbicse/go-projects --skill code-documenter-rabbicse

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill removes the repetitive, error-prone work of writing and maintaining technical documentation for codebases, APIs, and developer-facing guides.

Core Features & Use Cases

  • Inline Documentation: Adds consistent docstrings and JSDoc for public functions, classes, interfaces, and methods.
  • API Documentation: Produces framework-appropriate OpenAPI and Swagger documentation for Python and Node.js stacks.
  • Docs and Guides: Creates structured tutorials, getting-started guides, documentation portals, and coverage reports.
  • Validation Workflow: Checks examples and documentation outputs so the final result is accurate and maintainable.
  • Use Case: A team can hand over an undocumented service and receive clean function docs, endpoint specs, and a coverage summary for what still needs work.

Quick Start

Ask the skill to document your codebase using the preferred docstring style and framework-specific API documentation approach.

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 and Swagger specs for an existing Node.js or Python API?

To generate OpenAPI and Swagger specs, the skill detects your framework and produces framework-appropriate endpoint documentation. It validates examples to ensure your API specifications are accurate and maintainable.

What is the best way to add consistent JSDoc annotations and docstrings to an undocumented codebase?

Adding JSDoc annotations and docstrings is handled by generating inline documentation for public functions, classes, and methods. This ensures your codebase has consistent, validated documentation coverage.

Can I automatically create tutorials and getting-started guides from my source code?

You can create tutorials and getting-started guides from source code by generating structured documentation portals and user guides. The skill outputs these docs alongside a coverage report for remaining work.

Does this documentation generation approach work with both Python and Node.js projects?

Documentation generation works with both Python and Node.js projects. The skill detects your specific stack to produce appropriate docstrings, API specs, and documentation sites.

How do I check my documentation coverage report to see what still needs writing?

To check your documentation coverage report, the skill generates a summary highlighting documented functions and endpoints alongside what still needs work. This coverage report identifies gaps in your API documentation.

Why should I validate code examples in my technical documentation?

Validating code examples in technical documentation ensures your final output is accurate and maintainable. The skill checks examples and documentation outputs through a validation workflow to prevent errors.