bmad-document-project

Generates AI-ready architecture, data model, and API documentation for brownfield projects.

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/AhmedKaram50/research --skill bmad-document-project-ahmedkaram50
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/AhmedKaram50/research/tree/main/shopify-builder/_bmad/bmm/workflows/bmad-document-project
Command: npx skills add https://github.com/AhmedKaram50/research --skill bmad-document-project-ahmedkaram50

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document brownfield projects to provide AI-ready context and maintain traceable architecture records.

Core Features & Use Cases

  • Automated project documentation: Generate comprehensive docs for monorepos and multi-part projects.
  • Architecture, data models, and API mapping: Produce structured outputs that describe architecture patterns and data relationships.
  • Multi-part integration awareness: Document inter-part communication and deployment relationships for complex repos.

Quick Start

Provide the repository path and I will generate a comprehensive, browsable documentation suite for the project.

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 documentation for an existing brownfield project?▼

To generate documentation for an existing brownfield project, you provide the repository path. The Skill analyzes multi-part repositories to produce comprehensive docs, including architecture, data models, and API contracts.

Can I document multi-part repositories and map inter-part communication?▼

Yes, you can document multi-part repositories to map inter-part communication. The Skill provides multi-part integration awareness, documenting how different parts communicate and their deployment relationships.

How do I incrementally update existing architecture documentation?▼

You incrementally update existing architecture documentation by using the Skill's resumption and incremental update features. It supports adding deep-dive supplements to existing docs without regenerating the entire suite.

What is the best way to provide AI-ready context for developer onboarding?▼

The best way to provide AI-ready context for developer onboarding is to auto-generate comprehensive project documentation. This Skill produces a master index and structured architecture records to maintain traceable context.

Does this documentation tool work for monorepos?▼

Yes, this documentation tool works for monorepos. It is specifically designed to analyze multi-part repositories and generate a browsable documentation suite that describes architecture patterns and data relationships.