add-docs

Generate standards-compliant documentation for source code files across multiple programming languages.

2|Updated Feb 23, 2026
One-click install
npx skills add https://github.com/roach88/claude-config --skill add-docs-roach88
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-docs
Source: https://github.com/roach88/claude-config/tree/main/skills/add-docs
Command: npx skills add https://github.com/roach88/claude-config --skill add-docs-roach88

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually adding consistent, standards-compliant documentation to source code across multiple programming languages is extremely time-consuming, often leads to inconsistent formatting and missing documentation for critical functions, classes and modules, and creates unnecessary technical debt for development teams.

Core Features & Use Cases

  • Multi-language support: Automatically detects the programming language of each source file and applies the correct, industry-standard documentation format (Google-style docstrings for Python, JSDoc for JavaScript/TypeScript, JavaDoc for Java, Go doc comments for Go, etc.) for 9+ common languages.
  • Non-destructive editing: Only adds missing or incomplete documentation, never modifies existing code logic, function signatures, or well-written existing documentation to preserve codebase integrity.
  • Optional formatting: Runs language-appropriate formatters (ruff, black, prettier, rustfmt, gofmt, etc.) after adding documentation to ensure consistent code style across the entire codebase.
  • Use case: For a development team maintaining a codebase with hundreds of undocumented Python, TypeScript and Go files, this skill can automatically add compliant documentation to all public functions, classes and modules in minutes, drastically reducing the time spent on manual documentation work.

Quick Start

Use the add-docs skill to add compliant documentation to all source code files in the ./src directory.

Frequently Asked Questions about add-docs

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

FAQPage Schema
How do I automatically generate JSDoc and docstrings across a multi-language codebase?

You can automatically generate language-appropriate documentation like JSDoc, Google-style docstrings, and JavaDoc across multiple languages by running an automated documentation tool over your source files to add compliant comments to public functions and classes.

What is the best way to add missing documentation to existing source code without breaking logic?

The best way to add missing documentation safely is by using non-destructive automated documentation, which only adds incomplete or missing docstrings and never modifies existing code logic, function signatures, or well-written existing comments.

Does automated code documentation work with Python, TypeScript, Go, and Rust?

Yes, automated code documentation supports Python, JavaScript/TypeScript, Java, C#, Go, Rust, Ruby, PHP, and C/C++, applying the correct industry-standard documentation format for each specific programming language.

How do I ensure consistent code style after adding docstrings and JavaDoc to my files?

To ensure consistent code style after adding documentation, you can run optional language-appropriate formatters like ruff, black, prettier, rustfmt, or gofmt as a post-processing step to format the entire codebase.

Can I use automated documentation to reduce technical debt for developer onboarding?

Yes, you can use automated documentation to reduce technical debt and accelerate developer onboarding by instantly generating consistent, standards-compliant module and function documentation across undocumented multi-language project repositories.

What are the limitations of automated multi-language code documentation tools?

A key limitation of automated code documentation is that it targets source code files in specific supported languages and focuses solely on generating documentation, meaning it will not refactor underlying code logic or fix existing architectural issues.