bmad-document-project

Generates comprehensive documentation for brownfield codebases through configurable scan workflows.

Updated Aug 25, 2024
One-click install
npx skills add https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot --skill bmad-document-project-legerycheese
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot/tree/main/bmad/src/bmm-skills/1-analysis/bmad-document-project
Command: npx skills add https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot --skill bmad-document-project-legerycheese

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Brownfield projects often lack documentation that AI agents and developers need to understand existing architecture, APIs, and data models before planning new features. This Skill scans an existing codebase and produces a complete, structured documentation set ready for brownfield PRD workflows. ## Core Features & Use Cases - Multi-Level Scanning: Choose quick (pattern-based), deep (critical directories), or exhaustive (all source files) scan levels, with batching and write-as-you-go output to manage context. - Project Classification: Detects monolith, monorepo, and multi-part structures, classifies each part against 12 project types, and generates per-part architecture, API contract, and data model documents. - Deep-Dive Mode: Performs exhaustive file-by-file analysis of a selected folder, feature, or API group, producing dependency graphs, data flow traces, and modification guidance. - Resumable State: Tracks progress in a state file so interrupted scans can resume within 24 hours. - Use Case: Point the workflow at a legacy full-stack repository to generate an index.md, architecture docs, source tree analysis, and development guides that an AI agent can use to plan new features. ## Quick Start Ask the AI to document this project and follow the prompts to choose a scan level and confirm the detected project structure.

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 classifies your project type, then writes architecture, source tree, and development guide documents to the project knowledge folder.

What is the difference between quick, deep, and exhaustive scans?▼

Quick scan reads only configs and manifests without opening source files. Deep scan reads files in critical directories based on the detected project type. Exhaustive scan reads every source file excluding node_modules, dist, and build folders.

Can I document a monorepo with separate client and server parts?▼

Yes, the workflow detects multi-part structures and confirms them with you. It generates per-part architecture, component inventory, and development guide files, plus an integration-architecture document describing how the parts communicate.

What happens if the documentation scan is interrupted?▼

Progress is saved to a project-scan-report.json state file after each step. If you rerun the workflow within 24 hours, it offers to resume from the last completed step using cached project type data.

When should I use deep-dive mode instead of a full scan?▼

Use deep-dive mode when documentation already exists and you need exhaustive analysis of one specific area, such as a feature module or API group. It reads every file in scope and produces dependency graphs, data flow traces, and modification guidance.