bmad-document-project

Analyze directory structures and technology stacks to generate technical documentation for brownfield projects.

Updated May 13, 2026

Search Tags:#automation #architecture #documentation #onboarding #codebase #brownfield

Ready to run

npx skills add https://github.com/Markuson/ivo_corr --skill bmad-document-project-markuson

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/Markuson/ivo_corr/tree/main/.agents/skills/bmad-document-project
Command: npx skills add https://github.com/Markuson/ivo_corr --skill bmad-document-project-markuson

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3, and includes scripts (resource) components.

What problem does it solve?

This Skill solves the challenge of documenting legacy or brownfield projects by automating the discovery, analysis, and generation of comprehensive technical documentation.

Core Features & Use Cases

Automated Project Analysis: Intelligently detects project types and technology stacks to generate relevant documentation.
Resumable Workflows: Tracks progress via state files, allowing for deep-dive scans or full project updates without losing context.
Use Case: When onboarding to a complex legacy codebase, use this Skill to generate an architecture overview, API contracts, and a source tree analysis to immediately understand the system structure.

Quick Start

Activate the bmad-document-project skill and follow the prompts to initiate a full scan of your current project directory.

Frequently Asked Questions about bmad-document-project

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

FAQPage Schema

How do I automate technical documentation for a legacy codebase?▼

Automating technical documentation for a legacy codebase is achieved by scanning directory structures and detecting technology stacks to generate architecture overviews, API contracts, and source tree analyses automatically.

Can I resume a deep-dive codebase analysis if the process is interrupted?▼

Resuming a deep-dive codebase analysis is fully supported because the workflow tracks progress via state files and JSON reports, ensuring resumability across sessions without losing context.

Do I need Python 3 to generate architecture overviews for brownfield projects?▼

Python 3 is required to generate architecture overviews for brownfield projects, as it handles the workflow resolution and script execution needed to analyze the directory structures.

What is the best way to update documentation after a full rescan of an existing project?▼

Updating documentation after a full rescan of an existing project is handled natively by initiating a rescan update, which re-evaluates the technology stack and refreshes the technical docs while maintaining state.

How does automated project analysis handle complex brownfield technology stacks?▼

Automated project analysis handles complex brownfield technology stacks by intelligently detecting project types within the directory structure and generating relevant documentation tailored to the discovered stack.

When should I use an exhaustive deep-dive analysis instead of an initial project scan?▼

Exhaustive deep-dive analysis should be used instead of an initial project scan when you need to document specific modules in detail, rather than just generating a high-level architecture overview of the entire codebase.