skills.rest
Design-System-ET
Design-System-ETOFFICIAL
Explore all skills by this author →
GitHub

code-documenter

Generate docstrings, API specifications, and developer guides for Python, TypeScript, and JavaScript.

Updated Jun 16, 2026
Search Tags:#documentation#api#openapi#code-quality#jsdoc#swagger
One-click install
npx skills add https://github.com/Design-System-ET/genexus-dev-opencode --skill code-documenter-design-system-et
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/Design-System-ET/genexus-dev-opencode/tree/main/skills/code-documenter
Command: npx skills add https://github.com/Design-System-ET/genexus-dev-opencode --skill code-documenter-design-system-et

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates the manual burden of writing and maintaining technical documentation, ensuring your codebase remains well-documented, compliant, and easy for other developers to understand.

Core Features & Use Cases

  • Automated Documentation: Generates consistent docstrings, JSDoc annotations, and XML documentation for functions and classes.
  • API Specification: Maintains up-to-date OpenAPI, Swagger, and AsyncAPI specifications for REST and event-driven architectures.
  • Developer Guides: Creates onboarding tutorials, READMEs, and Architecture Decision Records (ADRs) to streamline team collaboration.

Quick Start

Invoke the code-documenter skill to generate JSDoc comments for all public functions in the current TypeScript project.

Frequently Asked Questions about code-documenter

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

FAQPage Schema
How do I generate JSDoc annotations for TypeScript functions automatically?▼

You can generate JSDoc annotations for TypeScript functions automatically by invoking the code-documenter skill, which analyzes your public classes and functions to produce consistent inline code documentation across your project.

What is the best way to maintain OpenAPI specifications for a REST API?▼

The best way to maintain OpenAPI specifications for a REST API is to automate documentation generation, ensuring your specs stay up-to-date with your codebase and consistently validate against your actual endpoint implementations.

Does the automated documentation work with both Python and JavaScript frameworks?▼

Automated documentation works with both Python and JavaScript frameworks, operating across these environments to generate docstrings, JSDoc annotations, and developer guides for your specific tech stack.

How do I create developer onboarding guides and Architecture Decision Records?▼

To create developer onboarding guides and Architecture Decision Records, use the code-documenter skill, which generates READMEs, tutorials, and ADRs to streamline team collaboration and document architectural choices.

Can I generate Swagger and AsyncAPI specifications for event-driven architectures?▼

You can generate Swagger and AsyncAPI specifications for event-driven architectures, allowing you to maintain accurate API documentation that covers both REST endpoints and asynchronous messaging protocols.

Related Skills

Explore More Software Engineering Skills→
crycriMcrycriM

codebase-skeleton

Compress source code repositories into compact skeletons with imports and signatures.

Community
Intermediate
newkayak12newkayak12
1

code-documenter

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

Community
Intermediate
0xRayAI0xRayAI

lint

Run node-based linting servers to enforce code quality standards.

Official
Intermediate
Muath2000Muath2000

technical-writer

Generate READMEs, ADRs, guides, and API references with Markdown standards.

Community
Advanced