code-documenter

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

1|Updated Mar 11, 2026

Search Tags:#code quality #documentation #OpenAPI #docstrings #API docs #JSDoc

Ready to run

npx skills add https://github.com/newkayak12/claude-skills --skill code-documenter-newkayak12

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-documenter
Source: https://github.com/newkayak12/claude-skills/tree/main/plugins/newkayak12-skills/skills/code-documenter
Command: npx skills add https://github.com/newkayak12/claude-skills --skill code-documenter-newkayak12

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, reducing the burden on developers and ensuring consistency.

Core Features & Use Cases

Automated Docstrings: Generates docstrings for functions and classes in various formats (Google, NumPy, JSDoc).
API Documentation: Creates OpenAPI/Swagger specifications for APIs.
Documentation Sites: Assists in building and structuring documentation portals.
Use Case: You have a Python project with several undocumented functions. Use this Skill to automatically generate Google-style docstrings for them, including parameters, return types, and examples.

Quick Start

Use the code-documenter skill to generate Google-style docstrings for the Python function calculate_total in the file src/utils.py.

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 undocumented Python functions?▼

Generate docstrings for undocumented Python functions by applying automated extraction for parameters, return types, and examples. This supports Google, NumPy, and JSDoc formats to ensure consistent technical documentation across your project.

What is the best way to create OpenAPI specifications from existing code?▼

Create OpenAPI specifications from existing code by automating the generation and validation of Swagger specs. This ensures your API documentation accurately reflects endpoints and parameters without requiring manual specification writing.

Can I use automated tools to build and structure a documentation portal?▼

Yes, you can use automated tools to build and structure documentation portals. They assist in organizing technical documentation, user guides, and tutorials into a cohesive site, reducing the manual setup burden on developers.

Does this documentation generation approach support JSDoc annotations for JavaScript projects?▼

Yes, this documentation generation approach supports JSDoc annotations for JavaScript projects. It automates the formatting and validation of JSDoc comments, ensuring your API docs and function annotations remain consistent.

What are the limitations of automating technical documentation generation?▼

The limitations of automating technical documentation generation include relying on existing code structure for accuracy. While it automates formatting and validation, complex business logic may still require manual review to ensure user guides and tutorials remain accurate.