bmad-document-project

Generate index, architecture, data models, API contracts, and deployment notes for brownfield codebases.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill documents brownfield projects to provide AI-ready context by generating comprehensive, actionable documentation of existing codebases and architectures when requested.

Core Features & Use Cases

  • Automatically discover project structure and detect project type
  • Generate multi-part architecture and integration documentation
  • Produce outputs for brownfield PRD workflows (index, architecture, data models, API docs, deployment notes)
  • Use when the user asks to document this project or generate project docs

Quick Start

Document the repository with the full brownfield PRD workflow to generate a complete set of AI-ready documentation (index, architecture, data models, APIs, and deployment notes).

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

To generate AI-ready documentation for a brownfield project, this skill discovers your project structure and produces comprehensive docs including index, architecture, data models, API contracts, and deployment notes for existing codebases.

What is the best way to document a monorepo with multi-part architectures?

Documenting a monorepo with multi-part architectures requires mapping integration points across project parts. This skill detects your project type and generates multi-part architecture and integration documentation for complex codebases.

How does automatic project type detection work for codebase documentation?

Automatic project type detection for codebase documentation works by analyzing the repository structure to identify frameworks and patterns, enabling the generation of tailored machine-readable metadata like index and deep-dive docs.

Can I use this to produce API contracts and data models for an undocumented codebase?

Yes, you can produce API contracts and data models for an undocumented codebase. The skill applies a documentation workflow that extracts these details to provide actionable AI context for brownfield PRD workflows.

What specific outputs are generated by the brownfield PRD documentation workflow?

The brownfield PRD documentation workflow generates a complete set of AI-ready outputs, specifically an index, architecture overviews, data models, API documentation, and deployment notes for the repository.

Do I need to manually structure index files when documenting multi-part architectures?

No, you do not need to manually structure index files. The skill automatically generates machine-readable metadata including index and project-parts documents to map multi-part integration points.