bmad-document-project

Generate architecture docs, data models, and API contracts for brownfield projects.

3|2|Updated Mar 29, 2024
One-click install
npx skills add https://github.com/josemariafs/MVTools --skill bmad-document-project-josemariafs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/josemariafs/MVTools/tree/main/.cursor/skills/bmad-document-project
Command: npx skills add https://github.com/josemariafs/MVTools --skill bmad-document-project-josemariafs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document brownfield projects for AI context by generating comprehensive project documentation and architecture artifacts that help teams reason about existing codebases.

Core Features & Use Cases

  • Conventions and runtime workflow steps for documenting client/server monoliths or multi-part systems.
  • Activation and customization flow to load configuration, determine project parts, and produce architecture and supporting docs.
  • Supports per-part documentation and deep-dive outputs including architecture, data models, and API contracts.

Quick Start

Invoke this skill on a brownfield project root to generate comprehensive documentation and architecture artifacts.

Frequently Asked Questions about bmad-document-project

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

FAQPage Schema
What is the best way to document a brownfield project for AI context?

The best way to document a brownfield project for AI context is to automate the generation of an index, source-tree analysis, architecture docs, data models, API contracts, and a JSON metadata file describing the system parts.

Can I generate API contracts and data models for client/server monoliths automatically?

Yes, you can automatically generate API contracts and data models for client/server monoliths by running conventions and runtime workflow steps that analyze the codebase and produce per-part deep-dive documentation.

How do I start automating project documentation on a brownfield codebase?

To start automating project documentation, invoke the skill on a brownfield project root to trigger the activation flow, which loads configuration, determines project parts, and outputs comprehensive architecture artifacts.

Does automated brownfield documentation support multi-part systems or just monoliths?

Automated brownfield documentation supports both client/server monoliths and multi-part systems, providing per-part documentation and deep-dive outputs including architecture, data models, and API contracts for each identified component.