code-documenter

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

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/shalevamin/The-_Ultimate_agents --skill code-documenter-shalevamin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/shalevamin/The-_Ultimate_agents/tree/main/.claude/skills/code-documenter
Command: npx skills add https://github.com/shalevamin/The-_Ultimate_agents --skill code-documenter-shalevamin

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation, formatting, and validation of technical documentation, ensuring code is well-documented and maintainable.

Core Features & Use Cases

  • Automated Docstrings: Generates docstrings for functions and classes in various formats (Google, NumPy, JSDoc).
  • API Documentation: Creates OpenAPI/Swagger specs for APIs.
  • Documentation Site Generation: Assists in building developer portals and user guides.
  • Validation: Ensures code examples within documentation are correct and runnable.
  • Use Case: When you've finished writing a new Python module, use this Skill to automatically generate Google-style docstrings for all public functions and classes, including parameters, return types, and examples.

Quick Start

Use the code-documenter skill to generate Google-style docstrings for the provided Python function.

Frequently Asked Questions about code-documenter

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

FAQPage Schema
How do I automatically generate docstrings for Python functions and classes?

To generate docstrings for Python functions and classes, you can use automated documentation tools to produce standardized formats like Google-style or NumPy-style annotations, including parameters, return types, and usage examples for maintainable code.

What is the best way to create OpenAPI specifications for my API endpoints?

The best way to create OpenAPI specifications is to use documentation generators that analyze your API code structure and automatically produce Swagger-compliant specs, ensuring accurate endpoint documentation without manual formatting errors.

Can I validate that code examples in my documentation are correct and runnable?

Yes, you can validate that code examples in your documentation are correct and runnable by using documentation validation features that check technical accuracy, ensuring inline code comments and user guides execute as expected.

Does automated documentation generation work with JSDoc annotations for JavaScript?

Automated documentation generation works with JSDoc annotations for JavaScript by parsing inline code comments and generating structured API documentation, ensuring consistent developer portals and user guides across multiple programming languages and frameworks.

How do I build a developer portal from existing code documentation?

To build a developer portal from existing code documentation, use documentation site generation features that aggregate validated docstrings and OpenAPI specs into comprehensive user guides and technical tutorials for your API consumers.