skills.rest
wesleyegberto
wesleyegbertoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

code-documenter

Convert code comments and API definitions into structured documentation artifacts.

3|2|Updated Mar 23, 2026
Search Tags:#documentation#openapi#jsdoc#docstrings#code-generation#api-docs
One-click install
npx skills add https://github.com/wesleyegberto/software-engineering-skills --skill code-documenter-wesleyegberto
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/wesleyegberto/software-engineering-skills/tree/main/plugins/docs/skills/code-documenter
Command: npx skills add https://github.com/wesleyegberto/software-engineering-skills --skill code-documenter-wesleyegberto

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Converting code comments, OpenAPI specs, and API definitions into cohesive, searchable documentation artifacts that teams can rely on.

Core Features & Use Cases

  • Generate inline docstrings, API specs (OpenAPI/Swagger), and API references from multi-language codebases.
  • Produce developer guides, tutorials, and documentation portals to accelerate onboarding and maintenance.
  • Use across REST, GraphQL services, and SDKs to keep docs in sync with the codebase.

Quick Start

Run a documentation generation pass against the repository to produce a ready-to-publish docs bundle.

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 and docstrings from a multi-language codebase?▼

You can generate OpenAPI specs and docstrings by running a documentation pass against your repository, which analyzes code comments and API definitions to produce structured, searchable documentation artifacts.

What is the best way to keep API documentation in sync with Python and TypeScript code?▼

The best way to keep API documentation in sync is to convert code comments and API definitions directly into consistent artifacts, supporting Python, TypeScript, REST APIs, and client SDKs across multiple doc styles.

Can I generate JSDoc and Google or NumPy style docstrings automatically?▼

Yes, you can automatically generate JSDoc, Google, and NumPy style docstrings from your existing code comments, applying these documentation styles consistently across your multi-language codebase.

Does unified code documentation generation work with REST, GraphQL services, and SDKs?▼

Unified code documentation generation works across REST, GraphQL services, and client SDKs, converting API definitions and code comments into cohesive developer guides, tutorials, and API references.

How do I produce developer guides and tutorials from API definitions?▼

You can produce developer guides and tutorials by processing API definitions and code comments, which are transformed into structured documentation portals and ready-to-publish docs bundles to accelerate onboarding.

When do I need to validate documentation outputs and load references for API docs?▼

You need to validate outputs and load references when converting diverse API definitions into consistent documentation, ensuring the generated OpenAPI specs, docstrings, and tutorials remain accurate and searchable.

Related Skills

Explore More Software Engineering Skills→
mei28mei28
3

doc-gen

Generate OpenAPI specs and Markdown API references from codebases.

Community
Advanced
newkayak12newkayak12
1

code-documenter

Generate, format, and validate technical documentation including docstrings and OpenAPI specs.

Community
Intermediate
haJ1thaJ1t

documentation-generator

Generates API references, READMEs, architecture docs, and ADRs from codebases.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate