bmad-document-project

Generates comprehensive architecture and development documentation for brownfield codebases.

Updated Aug 3, 2026
One-click install
npx skills add https://github.com/shaahy/quicknav-desktop --skill bmad-document-project-shaahy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/shaahy/quicknav-desktop/tree/main/A%20%E6%95%99%E7%A8%8B%E9%9B%86%E5%90%88/BMAD-METHOD%E6%8A%80%E8%83%BD%E9%80%9F%E6%9F%A5/source-v6.10.0/src/bmm-skills/1-analysis/bmad-document-project
Command: npx skills add https://github.com/shaahy/quicknav-desktop --skill bmad-document-project-shaahy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Brownfield projects often lack up-to-date documentation, making it hard for developers and AI agents to understand the existing system before planning new features or writing a PRD. This Skill scans an existing codebase and produces a complete, structured documentation set ready for AI-assisted development. ## Core Features & Use Cases - Multi-Level Project Scanning: Choose quick (pattern-based), deep (critical directories), or exhaustive (all source files) scan levels, with automatic project type detection across 12 project types. - Full Documentation Generation: Produces index.md, project overview, architecture docs, source tree analysis, API contracts, data models, development and deployment guides, plus integration architecture for multi-part projects. - Deep-Dive Mode: Exhaustively documents a specific folder, feature, or API group with file inventories, dependency graphs, data flow analysis, and modification guidance. - Resumable State Tracking: Maintains a project-scan-report.json state file so interrupted scans can resume within 24 hours. - Use Case: Point the workflow at a legacy client/server repository, run a deep scan, and receive architecture-client.md, architecture-server.md, api-contracts, and an index.md that a brownfield PRD workflow can consume directly. ## Quick Start Ask the AI to document this project and choose a scan level when prompted.

Frequently Asked Questions about bmad-document-project

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

FAQPage Schema
How do I document an existing brownfield project for AI context?▼

Run the document-project workflow and select a scan level: quick for pattern-based analysis, deep for critical directories, or exhaustive for all source files. It generates index.md, architecture docs, API contracts, and development guides in your project knowledge folder.

What scan level should I choose for project documentation?▼

Quick scan takes 2-5 minutes using only patterns and configs, deep scan takes 10-30 minutes reading critical directories, and exhaustive scan takes 30-120 minutes reading every source file. Deep scan is recommended for brownfield PRD preparation.

Can the workflow resume an interrupted project scan?▼

Yes, it maintains a project-scan-report.json state file updated after each step. If the state file is less than 24 hours old, you can resume from the exact step where the scan stopped; older state files are archived automatically.

Does it support monorepos or multi-part projects?▼

Yes, it detects multi-part structures like client/server folders and documents each part separately with per-part architecture, component inventory, and development guides. It also generates integration-architecture.md and project-parts.json describing how parts communicate.

What is deep-dive mode in project documentation?▼

Deep-dive mode exhaustively reads every file in a chosen folder, feature, or API group and produces a detailed document with file inventories, dependency graphs, data flow analysis, testing coverage, and modification guidance. Sampling or skipping files is not allowed in this mode.