bmad-document-project

Generate structured architecture, data model, and API documentation for brownfield repositories.

4|1|Updated Sep 30, 2024

Search Tags:#architecture #documentation #brownfield #ai-context #data-models #api-contracts #source-tree

Ready to run

npx skills add https://github.com/co-cddo/ndx --skill bmad-document-project-co-cddo

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/co-cddo/ndx/tree/main/_bmad/bmm/workflows/bmad-document-project
Command: npx skills add https://github.com/co-cddo/ndx --skill bmad-document-project-co-cddo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Brownfield projects often lack coherent AI-contextual documentation, slowing decision-making and product planning; this skill automates the generation of comprehensive docs to accelerate brownfield PRD workflows.

Core Features & Use Cases

Automated discovery and classification of project parts (mono/repo/multi-part) to tailor documentation.
Generation of architecture, data models, API contracts, deployment references, and governance artifacts for each part.
Use Case: A legacy codebase is quickly documented to enable AI-assisted planning, audits, and knowledge transfer.

Quick Start

Run the document-project workflow on your repository to generate comprehensive, AI-contextual documentation.

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 AI context documentation for a brownfield codebase?▼

To generate AI context documentation for a brownfield codebase, run the document-project workflow on your repository to analyze the source tree and produce structured architecture, data models, and API contracts.

What is the best way to document legacy code for product planning workflows?▼

Documenting legacy code for product planning involves automating the discovery of project parts and generating reusable architecture and deployment references, which accelerates brownfield PRD workflows and knowledge transfer.

Can I generate API contracts and data models for multi-part repositories?▼

Yes, you can generate API contracts and data models for multi-part repositories by running the workflow to automatically discover, classify, and tailor documentation for each distinct part of the project.

Does this documentation workflow support incremental updates for existing projects?▼

Yes, the documentation workflow supports incremental updates for existing projects by resuming from a saved state, allowing you to refresh architecture and deployment references without regenerating everything.

What types of documentation artifacts are produced from analyzing a repository structure?▼

Analyzing a repository structure produces comprehensive documentation artifacts including architecture overviews, data models, API contracts, deployment references, and development guidance tailored for AI-assisted planning.

Do I need to manually organize my source tree before generating brownfield project documentation?▼

No, you do not need to manually organize your source tree before generating brownfield project documentation because the workflow automatically discovers and classifies project parts to tailor the output.