doc-orchestration

Scan markdown files and code diffs to detect and prioritize documentation gaps.

7|3|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill doc-orchestration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-orchestration
Source: https://github.com/brainbrewlabs/brainbrew-devkit/tree/main/plugin/config/templates/develop/skills/doc-orchestration
Command: npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill doc-orchestration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Coordinate and automate multi-file documentation updates so docs remain accurate after large code changes, refactors, or feature additions. Reduce manual effort by detecting missing or stale documentation, aligning examples with current APIs, and ensuring cross-references are valid.

Core Features & Use Cases

  • Repository-wide scan & gap detection: Use glob and grep strategies to locate markdown files, inline docs, and undocumented public APIs.
  • Prioritization and triage: Rank gaps by impact (public API, README, internal docs) so the most critical updates are handled first.
  • Coordinated edits and verification: Apply targeted documentation updates (without changing source code), verify links and code examples, and produce a structured report of changes and remaining issues.
  • Use case: After a major refactor that renames public functions and updates endpoints, run this Skill to find affected docs, apply consistent updates across docs/, README, and API references, and validate examples.

Quick Start

Run the doc-orchestration skill to scan the repository for documentation gaps, prioritize updates, and apply coordinated edits to markdown files to sync them with recent code changes.

Frequently Asked Questions about doc-orchestration

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

FAQPage Schema
How do I keep markdown documentation synced with code changes after a major refactor?

To keep markdown documentation synced with code changes, scan markdown files and code diffs to detect documentation gaps, prioritize updates by impact, and apply targeted edits to markdown without modifying source code, then verify links and examples for consistency.

What is the best way to find undocumented public APIs in a git repository?

The best way to find undocumented public APIs is running a repository-wide scan using glob and grep strategies to locate markdown files, inline docs, and undocumented public APIs, ranking gaps by impact for prioritized triage.

How do I audit multiple markdown files for documentation gaps following a release?

Audit multiple markdown files for documentation gaps by scanning them alongside code diffs to detect stale documentation, aligning examples with current APIs, and ensuring cross-references are valid across the codebase.

Does documentation synchronization modify my source code files?

Documentation synchronization does not modify source code files. It applies targeted documentation updates exclusively to markdown files, verifying links and code examples for consistency while leaving the actual codebase untouched.

How are documentation gaps prioritized during a repository-wide doc audit?

Documentation gaps are prioritized during a repository-wide doc audit by ranking them according to impact, targeting public APIs, README files, and internal docs first so the most critical updates are handled before others.