skills.rest
NotTheRealRohit
NotTheRealRohitCOMMUNITY
Explore all skills by this author →
GitHub

code-documenter

Generate docstrings, OpenAPI specs, and static documentation sites.

1|Updated Mar 5, 2026
Search Tags:#code quality#documentation#OpenAPI#docstrings#Swagger#API docs#developer guides
One-click install
npx skills add https://github.com/NotTheRealRohit/TRACE --skill code-documenter-nottherealrohit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/NotTheRealRohit/TRACE/tree/main/.opencode/skills/code-documenter
Command: npx skills add https://github.com/NotTheRealRohit/TRACE --skill code-documenter-nottherealrohit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive documentation for code, APIs, and user guides, ensuring clarity and maintainability.

Core Features & Use Cases

  • Docstring Generation: Automatically adds docstrings to functions, classes, and methods following specified styles (e.g., Google, NumPy, JSDoc).
  • API Documentation: Creates OpenAPI/Swagger specifications from code annotations or definitions.
  • Documentation Site Building: Assists in setting up and populating static documentation sites using tools like Docusaurus or MkDocs.
  • Use Case: You have a Python FastAPI application with many endpoints. Use this Skill to generate an OpenAPI specification and integrate it into a Swagger UI portal for easy API exploration by developers.

Quick Start

Use the code-documenter skill to add docstrings to the calculate_total function in the provided Python file.

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

Generate OpenAPI specifications by analyzing code annotations and definitions to produce Swagger specs. This creates clear, maintainable API documentation integrated into portals for developer exploration.

What's the best way to add docstrings to an existing Python codebase?▼

Add docstrings by processing functions, classes, and methods to insert documentation following specified styles like Google, NumPy, or JSDoc, ensuring inline documentation remains clear and maintainable.

Can I use this to build a static documentation site with Docusaurus or MkDocs?▼

Build static documentation sites by setting up and populating frameworks like Docusaurus or MkDocs. This transforms inline code documentation into a discoverable, interactive portal.

Does API documentation generation work with FastAPI applications?▼

API documentation generation works with FastAPI applications by extracting endpoint definitions to create OpenAPI specifications, integrating seamlessly into a Swagger UI portal for exploration.

When do I need automated code documentation generation?▼

Automated code documentation generation is needed when addressing the demand for clear, maintainable, and discoverable technical documentation across different programming languages and frameworks.

Related Skills

Explore More Software Engineering Skills→
tomique34tomique34
8

api-docs-generator

Generate Markdown API documentation from OpenAPI specs, Python docstrings, and JSDoc/TSDoc comments.

Community
Advanced
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate
ekremmkasapekremmkasap

python-code-style

Enforce Python code style with ruff, mypy, and Google-style docstrings.

Community
Intermediate
nilecuinilecui
27

documentation-generation

Generates technical documentation for software projects, including API references and README files.

Community
Intermediate