skills.rest
stephanj
stephanjCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

code-documenter

Generate docstrings, OpenAPI specs, and developer guides from source code.

9|2|Updated Jan 29, 2026
Search Tags:#documentation#api#openapi#technical writing#jsdoc#docstrings
One-click install
npx skills add https://github.com/stephanj/claude-code-collections --skill code-documenter-stephanj
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/stephanj/claude-code-collections/tree/main/skills/code-documenter
Command: npx skills add https://github.com/stephanj/claude-code-collections --skill code-documenter-stephanj

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill solves the challenge of maintaining accurate, up-to-date technical documentation by automating the generation of docstrings, API specifications, and developer guides.

Core Features & Use Cases

  • Automated Documentation: Generates language-specific docstrings and API specs (OpenAPI/Swagger) directly from your codebase.
  • Documentation Portals: Assists in setting up and structuring static documentation sites like Docusaurus, MkDocs, and VitePress.
  • Use Case: When you finish a new feature in a FastAPI or NestJS project, use this Skill to generate the corresponding OpenAPI schema and update your interactive API portal without manual writing.

Quick Start

Invoke the code-documenter skill to analyze the current directory and generate missing JSDoc comments for all public functions.

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 specifications from source code automatically?▼

You can generate OpenAPI specifications directly from your source code by analyzing the codebase structure. This Skill automates the extraction of API schemas and creates compliant Swagger documentation without requiring manual specification writing.

What's the best way to automate JSDoc docstring generation for public functions?▼

Automating JSDoc generation involves analyzing your codebase to produce language-specific docstrings for public functions. This Skill structures inline documentation formatting automatically, ensuring consistent coverage across your JavaScript or TypeScript project.

Can I set up a Docusaurus or MkDocs documentation portal from my existing codebase?▼

Yes, you can set up static documentation sites like Docusaurus, MkDocs, or VitePress. This Skill assists in structuring and organizing developer guides and API portals derived from your existing source code analysis.

Does this documentation tool support multiple programming languages and frameworks?▼

This documentation tool supports various programming languages and frameworks. It performs structured analysis of source code to generate language-specific docstrings, ensuring consistent formatting across different tech stacks like FastAPI or NestJS.

How do I update an interactive API portal after adding a new feature?▼

To update an interactive API portal after adding a feature, analyze the modified source code to regenerate the corresponding OpenAPI schema. This process updates the portal automatically without manual writing or schema adjustments.

What is documentation coverage reporting and how does it work?▼

Documentation coverage reporting tracks the completeness of inline documentation across your codebase. It works by analyzing source files to identify missing docstrings and ensure comprehensive technical documentation requirements are satisfied.

Related Skills

Explore More Software Engineering Skills→
mscipiomscipio

doc-generator

Generate README, API, and CLI documentation from source code comments.

Community
Advanced
herdiansahherdiansah
23

api-documenter

Create OpenAPI 3.1 specifications and generate interactive developer portals.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
Design-System-ETDesign-System-ET

code-documenter

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

Official
Advanced