bmad-document-project

Document brownfield software projects into structured, AI-consumable architecture and API documentation.

Updated Mar 25, 2026
One-click install
npx skills add https://github.com/JingyiWng/databricks_ai_dev_kit_price_watcher --skill bmad-document-project-jingyiwng
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/JingyiWng/databricks_ai_dev_kit_price_watcher/tree/main/_bmad/bmm/workflows/bmad-document-project
Command: npx skills add https://github.com/JingyiWng/databricks_ai_dev_kit_price_watcher --skill bmad-document-project-jingyiwng

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many brownfield codebases lack consistent, machine-readable documentation for architects, developers, and AI agents; this workflow automates discovery, classification, and generation of architecture, API, data model, and developer documentation so projects become understandable and actionable.

Core Features & Use Cases

  • Resumable scans & state tracking: detect existing state, resume or archive older runs, and store incremental progress to enable long-running analyses.
  • Configurable scan depths & batching: quick (pattern-only), deep (critical files), and exhaustive (full-file) modes with per-subfolder batching and write-as-you-go outputs for large repositories.
  • Targeted deep-dive mode: exhaustive, literal full-file reviews that produce file inventories, dependency graphs, data-flow analyses, and deep-dive markdown artifacts.
  • Template-driven outputs: generates index.md, architecture docs, api-contracts, data-models, source-tree analysis, and deep-dive documents using provided templates and validation checklists.

Quick Start

Document this project to run an initial scan and generate foundational documentation in the project knowledge folder.

Frequently Asked Questions about bmad-document-project

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

FAQPage Schema
How do I generate architecture documentation for an existing codebase?

To generate architecture documentation for a brownfield project, you can scan the codebase to automatically discover, classify, and output structured architecture, API contracts, and data models. The process uses configurable scan depths and template-driven outputs written directly to a project knowledge folder.

Can I resume a documentation scan if it stops halfway through a large repository?

Yes, you can resume an interrupted documentation scan on a large repository because the process implements resumable state tracking. It detects existing state, archives older runs, and stores incremental progress to enable long-running analyses without losing data.

What is the best way to document API contracts and data models for a monolith codebase?

The best way to document API contracts and data models for a monolith codebase is using an automated deep-dive scan. This method performs exhaustive full-file reviews to produce file inventories, dependency graphs, data-flow analyses, and structured markdown artifacts.

Does brownfield project documentation support quick scans for pattern-only analysis?

Yes, brownfield project documentation supports quick scans for pattern-only analysis. You can choose between quick, deep, and exhaustive scan modes to control the depth of file analysis and documentation generation based on your immediate needs.

How do I handle exhaustive documentation scans for multi-part repositories without timing out?

To handle exhaustive scans for multi-part repositories without timing out, the documentation process uses per-subfolder batching and write-as-you-go outputs. This approach breaks down large scans into manageable chunks and saves progress incrementally.