forcetrainer
e535f94325
Style Guide Additions: - Add Reference Structure section with 6 document types (Index, Catalog, Deep-Dive, Configuration, Glossary, Comprehensive) - Add Glossary Structure section with table-based format leveraging Starlight's right-nav for navigation - Include checklists for both new document types Reference Docs Updated: - agents/index.md: Catalog format, universal commands tip admonition - configuration/core-tasks.md: Configuration format with admonitions - configuration/global-config.md: Table-based config reference - workflows/index.md: Minimal index format - workflows/core-workflows.md: Catalog format - workflows/document-project.md: Deep-dive with Quick Facts admonition - workflows/bmgd-workflows.md: Comprehensive format, removed ~30 hr rules Glossary Rewritten: - Converted from 373 lines with ### headers to 123 lines with tables - Right nav now shows 9 categories instead of 50+ terms - Added italic context markers (*BMGD.*, *Brownfield.*, etc.) - Alphabetized terms within categories - Removed redundant inline TOC All Docs: - Remove horizontal rules (---) per style guide - Remove "Related" sections (sidebar handles navigation) - Standardize admonition usage - Archive deleted workflow customization docs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2.0 KiB
title
| title |
|---|
| Document Project Workflow |
Analyzes and documents brownfield projects for AI-assisted development.
:::note[Quick Facts]
- Module: BMM (BMad Method Module)
- Command:
*document-project - Agents: Analyst, Technical Writer
- Output: Master index + documentation files in
{output_folder}:::
Purpose
Scans your codebase, architecture, and patterns to create comprehensive reference documentation. Generates a master index and multiple documentation files tailored to your project structure and type.
How to Invoke
*document-project
Scan Levels
Choose the right depth for your needs:
Quick Scan (Default)
What it does: Pattern-based analysis without reading source files
Reads: Config files, package manifests, directory structure, README
Use when:
- You need a fast project overview
- Initial understanding of project structure
- Planning next steps before deeper analysis
Deep Scan
What it does: Reads files in critical directories based on project type
Reads: Files in critical paths defined by documentation requirements
Use when:
- Creating comprehensive documentation for brownfield PRD
- Need detailed analysis of key areas
- Want balance between depth and speed
Exhaustive Scan
What it does: Reads ALL source files in project
Reads: Every source file (excludes node_modules, dist, build, .git)
Use when:
- Complete project analysis needed
- Migration planning requires full understanding
- Detailed audit of entire codebase
:::caution[Deep-Dive Mode] Deep-dive mode always uses exhaustive scan — no choice of scan level. :::
Resumability
The workflow can be interrupted and resumed without losing progress:
- State Tracking — Progress saved in
project-scan-report.json - Auto-Detection — Workflow detects incomplete runs (<24 hours old)
- Resume Prompt — Choose to resume or start fresh
- Step-by-Step — Resume from exact step where interrupted
- Archiving — Old state files automatically archived