add-docs
CommunityGenerate concise inline docs for public APIs
Authormattbobambrose
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Many codebases lack clear inline documentation for public symbols, making it hard for new contributors and maintainers to understand APIs quickly. This Skill automates detection of undocumented public functions, methods, classes, and constants and assists in adding concise, idiomatic doc comments without overwriting existing documentation.
Core Features & Use Cases
- Language-aware doc generation: Detects comment styles for Kotlin/Java (KDoc), TypeScript/JavaScript (JSDoc), Python (Google-style docstrings), Go, and Rust and generates appropriate comment blocks.
- Safe, review-first edits: Reads files, lists undocumented symbols, prompts for confirmation before editing, and preserves any existing comments.
- Reporting and flagging: Produces a summary of files changed, counts of comments added, and marks symbols that are unclear and require human clarification.
Quick Start
Add inline doc comments to all undocumented public symbols under src/ and show a confirmation prompt before making any edits.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: add-docs Download link: https://github.com/mattbobambrose/mattbobambrose-claude-skills/archive/main.zip#add-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.