Which programming languages does this skill support?

It provides specific support for Python (Google/NumPy styles), Rust (/// and //! comments), TypeScript/JavaScript (JSDoc), and Go package comments.

Can I use it to find missing documentation?

Yes, when invoked without arguments, the skill surveys your project for documentation gaps and reports what is missing or stale, prioritized by impact.

How does doc-a handle architecture documentation?

Using the 'arch' argument, the skill reads the actual code structure to create system maps, component diagrams, and flow paths rather than relying on guessed logic.

Does it create internal design documents?

No, doc-a focuses on user-facing documentation that lives alongside the code. Internal agent design docs are typically kept in a separate directory like 'design-docs/'.

Automated Code Documentation

Name: Automated Code Documentation
Author: JSai23

byJSai23

•

学习与文档

Generates and maintains concise, standardized code documentation including docstrings, API references, and architecture guides.

Automated Code Documentation is a specialized skill designed to streamline the creation and maintenance of high-quality, user-facing documentation directly within your codebase. It supports multiple languages including Python, Rust, TypeScript, and Go, focusing on the core principle of brevity to ensure documentation remains scannable and relevant. Whether you need to audit missing docstrings, generate step-by-step how-to guides from existing logic, or map out system architecture, this skill helps developers keep their technical debt low and their documentation impact high without manual overhead.

主要功能

01Automated generation of scannable, step-by-step how-to guides

021 GitHub stars

03Documentation gap analysis to prioritize missing or stale content

04Enforcement of industry-standard styles like Google/NumPy docstrings and JSDoc

05High-level architecture mapping based on actual code structure

06Multi-language API documentation support for Python, Rust, TS/JS, and Go

使用场景

01Auditing a project to identify and fix missing documentation on public-facing APIs

02Syncing API docstrings and examples with recent logic changes in a large repository

03Generating a new how-to guide for a specific module by scanning its implementation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jsai23/claude-tooling doc-a

For use in Claude.ai and ChatGPT

Download Skill