skills.rest
mattbobambrose
mattbobambroseCOMMUNITY
Explore all skills by this author →
GitHub

update-docs

Generate or update Markdown API documentation from build manifests and source trees.

1|Updated Feb 26, 2026
Search Tags:#documentation#markdown#api#codebase#generate#module-docs#docgen
One-click install
npx skills add https://github.com/mattbobambrose/mattbobambrose-claude-skills --skill update-docs-mattbobambrose
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/mattbobambrose/mattbobambrose-claude-skills/tree/main/plugins/documentation/skills/update-docs
Command: npx skills add https://github.com/mattbobambrose/mattbobambrose-claude-skills --skill update-docs-mattbobambrose

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates creation and maintenance of Markdown documentation for a project's public API and modules, removing manual, error-prone writing and preventing stale or missing docs.

Core Features & Use Cases

  • Source discovery: Reads build and manifest files and globs source directories to identify modules, exported symbols, and language/runtime.
  • Merge-aware generation: Creates per-module Markdown files and an index while preserving any hand-written sections in existing docs instead of overwriting them.
  • Reporting and gaps: Lists files written or updated and highlights public symbols that lack sufficient context for accurate documentation.
  • Use case: Run against a multi-language repo to produce a docs/ directory with module-level API pages and a linked index for developer onboarding.

Quick Start

Run the update-docs skill targeting the desired output directory to generate or update Markdown API documentation for the repository.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I generate Markdown API documentation for a multi-language codebase?▼

Generate Markdown API documentation by reading build manifests and source trees to discover exported symbols, producing per-module Markdown files and a linked index.md table of contents in the output directory.

What's the best way to update module docs without overwriting hand-written sections?▼

Update module docs using merge-aware generation that preserves existing hand-written sections in Markdown files while merging newly generated API documentation for public symbols.

Can I document public APIs in repositories with multiple programming languages?▼

Yes, you can document public APIs across multiple languages by reading build manifests and globbing source directories to identify language runtime, module boundaries, and exported symbols.

Why does API documentation generation skip or miss certain public symbols?▼

API documentation generation reports public symbols that lack sufficient context for accurate documentation, highlighting these gaps so developers can add the necessary source code details.

What is merge-aware Markdown docgen and when do I need it?▼

Merge-aware Markdown docgen generates per-module API documentation while preserving existing hand-written sections, needed when maintaining a docs directory without losing manual additions.

Related Skills

Explore More Software Engineering Skills→
nholder88nholder88
2

code-documentation

Generate language-native documentation comments for exported symbols across codebases.

Community
Intermediate
gaiastudio-aigaiastudio-ai
2

gaia-index-docs

Indexes Markdown, XML, YAML, and CSV files in a folder into a linked table of contents in index.md.

Official
Intermediate
softwarebyzesoftwarebyze

expo-cicd-workflows

Generate and validate Expo EAS workflow YAML files against the official schema.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate