code-documenter

Generate and validate docstrings, OpenAPI/Swagger specs, and user guides.

2|Updated Jun 29, 2026
One-click install
npx skills add https://github.com/Axel-DaMage/opencode-config --skill code-documenter-axel-damage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/Axel-DaMage/opencode-config/tree/main/skills/code-documenter
Command: npx skills add https://github.com/Axel-DaMage/opencode-config --skill code-documenter-axel-damage

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, jsdoc, swagger-tools, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the generation, formatting, and validation of technical documentation, including docstrings, API specs, and user guides, streamlining the documentation process.

Core Features & Use Cases

  • Documentation Generation: Automatically generates documentation for code, APIs, and user guides.
  • Format Validation: Validates the formatting of docstrings and API specifications.
  • Use Case: Ideal for developers who need to maintain up-to-date documentation for their projects, ensuring consistency and accuracy.

Quick Start

Use the code-documenter skill to generate documentation for your project 'my_project'.

Frequently Asked Questions about code-documenter

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

FAQPage Schema
How do I automate code documentation generation for docstrings and OpenAPI specs?

You can automate code documentation generation by parsing your codebase to extract structure and comments, then formatting them into docstrings and OpenAPI/Swagger specs. This Skill validates formatting and generates user guides to ensure project consistency.

What is the best way to validate Swagger and JSDoc formatting in my codebase?

The best way to validate Swagger and JSDoc formatting is by checking syntax against specification standards. This Skill automates format validation for API specifications and docstrings, ensuring technical accuracy and consistency without manual review.

Do I need Python and JSDoc installed to generate OpenAPI documentation?

Yes, you need Python, JSDoc, and Swagger tools installed in your environment. These dependencies are required to execute the scripts that parse your codebase and generate validated technical documentation.

Can I automatically generate user guides from my existing codebase?

You can automatically generate user guides from an existing codebase by extracting function definitions and API endpoints, then compiling them into readable documentation. This Skill automates that process, creating guides alongside docstrings and API specs.

How do I keep my API specifications up to date when my code changes?

To keep API specifications up to date, use automated validation against the current codebase structure. This Skill generates and validates OpenAPI/Swagger specs continuously, ensuring your documentation reflects the latest code modifications accurately.