Does it document private or internal functions?

By default, the skill focuses on public API and exported symbols to ensure the documentation remains relevant for end-users and avoids implementation details.

What languages and build tools are supported?

It supports a wide range of ecosystems by detecting manifest files like build.gradle.kts, package.json, Cargo.toml, go.mod, and pyproject.toml.

Does this skill overwrite my custom manual notes?

No, the skill is designed to identify and carry over hand-written content verbatim, such as design rationales or diagrams, while only updating the auto-derivable API sections.

Can I specify where the documentation is saved?

Yes, you can provide an optional output directory argument; otherwise, it defaults to creating or updating files within the docs/ folder.

API Documentation Generator

Name: API Documentation Generator
Author: mattbobambrose

bymattbobambrose

•

学習とドキュメンテーション

Automates the creation and maintenance of comprehensive Markdown documentation for project APIs and module structures.

The update-docs skill streamlines the technical writing process by analyzing your project's source code and manifest files to generate structured Markdown documentation. It intelligently identifies public APIs, function signatures, and module relationships across various programming languages and build systems. Unlike simple generators, it preserves hand-written sections such as design rationales and migration guides, ensuring that human-curated context is never lost while keeping technical details perfectly in sync with the codebase.

主な機能

01Support for multi-module projects with relative linking between documentation files

02Automatic detection of project layouts via manifest files like package.json, Cargo.toml, and pyproject.toml

03Intelligent extraction of public classes, functions, and interfaces from source files

04Automatic generation of a linked table of contents and logical file structures

051 GitHub stars

06Smart merging that preserves manually written documentation and custom sections

ユースケース

01Audit and document undocumented public symbols in legacy codebases

02Bootstrap complete technical documentation for a new software project or library

03Synchronize API documentation with recent code changes before a major release

主な機能

01Support for multi-module projects with relative linking between documentation files

02Automatic detection of project layouts via manifest files like package.json, Cargo.toml, and pyproject.toml

03Intelligent extraction of public classes, functions, and interfaces from source files

04Automatic generation of a linked table of contents and logical file structures

051 GitHub stars

06Smart merging that preserves manually written documentation and custom sections

ユースケース

01Audit and document undocumented public symbols in legacy codebases

02Bootstrap complete technical documentation for a new software project or library

03Synchronize API documentation with recent code changes before a major release