bmad-document-project

Document brownfield projects with YAML frontmatter and output templates.

Updated Apr 25, 2026

Search Tags:#workflow #architecture #documentation #brownfield #ai-context #prds

Ready to run

npx skills add https://github.com/ldk-hub/broke-shopping --skill bmad-document-project-ldk-hub

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/ldk-hub/broke-shopping/tree/main/.claude/skills/bmad-document-project
Command: npx skills add https://github.com/ldk-hub/broke-shopping --skill bmad-document-project-ldk-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document brownfield projects to provide AI-contextual documentation, enabling faster onboarding and richer AI reasoning about existing systems.

Core Features & Use Cases

Frontmatter-driven discovery and activation: Uses the mandatory SKILL.md entry to identify and load the skill.
Multi-part architecture support: Documents monoliths, monorepos, and multi-part systems with per-part inventories and workflow bindings.
Output templates for brownfield PRD: Generates comprehensive documentation artifacts such as index, architecture, data models, and API contracts to support planning and execution.

Quick Start

Provide the path to the project root and ask the skill to generate complete documentation for that codebase.

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

Documenting a brownfield project for AI context requires generating index, architecture, and data-model templates from the codebase. This skill produces consistent project docs with YAML frontmatter, enabling fast onboarding and contextual AI guidance for monoliths, monorepos, and multi-part repositories.

Can I document multi-part architectures like monorepos for AI consumption?▼

Yes, you can document multi-part architectures like monorepos for AI consumption. The skill supports monoliths, monorepos, and multi-part systems by generating per-part inventories and workflow bindings for consistent project documentation.

What output templates are generated for brownfield PRD workflows?▼

The output templates generated for brownfield PRD workflows include index, architecture, data models, and API contracts. These comprehensive documentation artifacts support planning and execution for existing codebases.

Do I need YAML frontmatter for project documentation discovery?▼

Yes, YAML frontmatter is mandatory for project documentation discovery. The skill uses a mandatory SKILL.md entry with YAML frontmatter to identify, load, and activate the documentation workflow for AI consumption.

What's the best way to onboard AI onto an existing codebase without losing context?▼

The best way to onboard AI onto an existing codebase is generating consistent project docs with YAML frontmatter-based discovery. This provides AI-contextual documentation including architecture and data models, enabling richer AI reasoning about the system.