skills.rest
Wizarck
WizarckCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

bmad-document-project

Generate comprehensive architecture and codebase documentation for brownfield projects.

2|Updated Apr 19, 2026
Search Tags:#architecture#documentation#codebase analysis#brownfield#project scanning#deep-dive#bmad
One-click install
npx skills add https://github.com/Wizarck/nexandro --skill bmad-document-project-wizarck
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/Wizarck/nexandro/tree/main/skills/bmad-document-project
Command: npx skills add https://github.com/Wizarck/nexandro --skill bmad-document-project-wizarck

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 a 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 Generation: Produces index.md, project-overview.md, architecture docs, source-tree-analysis.md, API contracts, data models, development and deployment guides, with multi-part/monorepo support. - 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 Skill at a legacy NestJS/Next.js monorepo 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 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 agents?▼

Run the document-project workflow, which scans your codebase, detects the project type, and generates architecture docs, source tree analysis, API contracts, and a master index.md. The output is designed so AI agents can understand the system for brownfield PRD planning.

What scan levels does the document-project workflow support?▼

Three levels: quick scan uses pattern matching without reading source files, deep scan reads files in critical directories based on project type, and exhaustive scan reads every source file excluding node_modules, dist, and build folders.

Can the workflow handle monorepos or multi-part projects?▼

Yes. It detects multiple parts such as client and server folders, classifies each part separately, generates per-part architecture and development guides, and creates an integration-architecture.md plus a project-parts.json metadata file.

Can I resume an interrupted project documentation scan?▼

Yes. The workflow writes a project-scan-report.json state file after each step. If the state file is less than 24 hours old, you can resume from the last completed step; older state files are archived and a fresh scan starts.

What is deep-dive mode and when should I use it?▼

Deep-dive mode exhaustively reads every file in a chosen folder, feature, or API group and produces a detailed document with exports, dependency graphs, data flow, side effects, and modification guidance. Use it before implementing changes in a specific area.

Related Skills

Explore More Software Engineering Skills→
lukasPWRlukasPWR

10x-agents-md

Generate repository guides for AI agents from structure, scripts, and configuration files.

Community
Advanced
ValueMediaValueMedia

10x-shape

Guide users through creating a structured PRD with AI-assisted discovery questions.

Official
Advanced
astrovilleastroville

dependency-analysis

Evaluates software libraries for health, security, license compatibility, and size impact.

Official
Intermediate
LinoWhyLinoWhy

create-architecture-documentation

Generate C4 or arc42 architecture documentation from codebases and existing documentation.

Community
Intermediate