bmad-document-project

Generates comprehensive architecture and codebase documentation for brownfield projects.

Updated Jun 3, 2026
One-click install
npx skills add https://github.com/MathematicGuy/team-006-vin20k --skill bmad-document-project-mathematicguy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/MathematicGuy/team-006-vin20k/tree/main/.agent/skills/bmad-document-project
Command: npx skills add https://github.com/MathematicGuy/team-006-vin20k --skill bmad-document-project-mathematicguy

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 codebase before planning new features. This Skill scans an existing project and produces a complete, structured documentation set ready for brownfield PRD workflows. ## 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 Suite: Generates index.md, project-overview, architecture, source-tree-analysis, API contracts, data models, development and deployment guides, plus integration architecture for multi-part projects. - Deep-Dive Mode: Performs exhaustive file-by-file analysis of a specific folder, feature, or API group, producing dependency graphs, data flow traces, and implementation guidance. - Resumable State Tracking: Maintains a project-scan-report.json state file so interrupted scans can resume within 24 hours. - Use Case: Point the Skill at a legacy full-stack repository and receive a complete documentation set that an AI agent can use to plan new features without re-reading the entire codebase. ## Quick Start Ask the agent to document this project and follow the prompts to choose a scan level and confirm the detected project classification.

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 documentation for an existing codebase?▼

Run the document-project workflow and choose a scan level: quick for pattern-based analysis, deep for critical directories, or exhaustive for all source files. The workflow detects your project type automatically and writes architecture, API, data model, and development guide documents to your project knowledge folder.

What scan level should I use for brownfield project documentation?▼

Use quick scan for a fast overview without reading source files, deep scan to read files in critical directories for PRD-ready documentation, or exhaustive scan to read every source file for migration planning or detailed audits.

Can I document only a specific folder or feature in my project?▼

Yes, deep-dive mode targets a specific folder, file, feature, API group, or component group. It reads every file in scope exhaustively and produces a document with exports, dependency graphs, data flow, side effects, and modification guidance.

Does the workflow support monorepos and multi-part projects?▼

Yes, it detects multi-part structures such as client and server folders, documents each part separately with part-specific architecture and development guides, and generates an integration-architecture document plus a project-parts.json metadata file.

What happens if the documentation scan is interrupted?▼

The workflow 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.