code-documenter

Generate, format, and validate technical documentation for Python and TypeScript codebases.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/kamelmh/opencode-config --skill code-documenter-kamelmh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/kamelmh/opencode-config/tree/main/skills/code-documenter
Command: npx skills add https://github.com/kamelmh/opencode-config --skill code-documenter-kamelmh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill removes the burden of writing and maintaining accurate technical documentation for codebases, APIs, and developer-facing content, helping teams keep documentation consistent, complete, and trustworthy.

Core Features & Use Cases

  • Code Documentation: Adds and improves docstrings, JSDoc annotations, and class or function documentation across Python and TypeScript projects.
  • API Documentation: Creates and maintains OpenAPI, Swagger, and framework-specific API docs for FastAPI, Django, NestJS, and Express.
  • Guides and Portals: Produces user guides, tutorials, documentation site structures, and coverage reports for developer workflows.
  • Use Case: A team with undocumented services can use this Skill to document public methods, add endpoint specs, validate examples, and generate a coverage summary in one workflow.

Quick Start

Ask the skill to document your codebase using the preferred doc style, target framework, and any files or functions you want excluded.

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 or Swagger specs for an existing API?

To generate OpenAPI or Swagger specs, provide your codebase to the skill and specify the target framework. It analyzes endpoints, parameters, and errors to produce validated API documentation and coverage reports.

Can I add JSDoc and docstrings to Python and TypeScript projects automatically?

Yes, you can add JSDoc and docstrings to Python and TypeScript projects by asking the skill to annotate your code. It applies framework-aware documentation strategies to ensure public methods and functions are fully documented.

What's the best way to create tutorials and user guides from a codebase?

The best way to create tutorials and user guides is to use this skill to extract validated examples and structural logic from your code. It produces documentation portal structures and developer-facing content with coverage reporting.

Does this documentation tool work with FastAPI, Django, NestJS, and Express?

Yes, this documentation tool works with FastAPI, Django, NestJS, and Express. It creates and maintains framework-specific API documentation and validates endpoint specifications across these platforms.

How do I validate code examples and report documentation coverage?

You validate code examples and report documentation coverage by requesting a coverage summary from the skill. It checks parameter, return, and error coverage while validating examples against your actual codebase logic.

Why does my API documentation lack parameter, return, and error coverage?

Your API documentation lacks coverage because manual updates often miss parameter, return, and error definitions. This skill enforces required coverage and validates technical documentation to keep specs complete and trustworthy.