code-documenter

Generate and validate docstrings, API specs, and developer guides from code.

Updated Jun 9, 2026

Search Tags:#documentation #openapi #validation #jsdoc #docstrings #swagger

Ready to run

npx skills add https://github.com/alsmadi99/dotfiles --skill code-documenter-alsmadi99

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation tends to drift from code, making it hard for new contributors to understand APIs, behavior, and design decisions. This skill automates the creation, formatting, and validation of docstrings, API specs, JSDoc, and developer guides to keep docs aligned with code.

Core Features & Use Cases

Generate docstrings for functions/classes across languages (Python, TypeScript) and maintain OpenAPI/Swagger specs.
Validate documentation against code examples and tests, ensuring accuracy and consistency.
Produce ready-to-publish documentation sites and tutorials from existing codebases.

Quick Start

Run the skill against a codebase to generate and validate documentation artifacts for all public interfaces.

Frequently Asked Questions about code-documenter

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

FAQPage Schema

How do I generate docstrings for Python and TypeScript functions automatically?▼

You can generate docstrings for Python and TypeScript functions by running this skill against your codebase to identify code patterns and apply consistent formatting standards across all public interfaces.

How do I validate OpenAPI and Swagger specs against my source code?▼

You can validate OpenAPI and Swagger specs by checking the documentation against code examples and tests, ensuring accuracy and consistency.

What is the best way to keep documentation from drifting from code?▼

The best way to prevent documentation drift is to automate the creation, formatting, and validation of technical documentation from code by validating against code examples and tests.

Can I produce ready-to-publish developer guides from an existing codebase?▼

Yes, you can produce ready-to-publish developer guides and tutorials directly from existing codebases by identifying code patterns and selecting the right documentation strategy.

Does this documentation generation approach work across different software ecosystems?▼

Yes, this documentation generation approach works across software ecosystems, specifically handling Python, TypeScript, OpenAPI, and similar environments to produce consistent, testable artifacts.