bmad-document-project

Document brownfield repositories into structured markdown project knowledge.

1|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/mol4/BMAD-Board --skill bmad-document-project-mol4
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/mol4/BMAD-Board/tree/main/BMAD%20board/.agents/skills/bmad-document-project
Command: npx skills add https://github.com/mol4/BMAD-Board --skill bmad-document-project-mol4

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns an existing brownfield codebase into structured, AI-ready project documentation so teams can understand, resume, and extend a repository with less guesswork.

Core Features & Use Cases

  • Project classification and scanning: Detects repository structure, identifies project parts, and chooses the right documentation path for the codebase.
  • Resumable documentation workflow: Tracks scan state, supports resume or fresh starts, and keeps high-level findings available for later continuation.
  • Generated project knowledge: Produces index, overview, source tree, architecture, development, deployment, and optional API or data documentation.
  • Use case: A developer joins an existing project and uses this Skill to generate a clear documentation set that explains structure, stack, setup, and integration points.

Quick Start

Use this Skill to document the current repository into AI-ready project knowledge and generate the core markdown artifacts for the 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 architecture documentation for an existing brownfield repository?

To generate architecture documentation for an existing codebase, this Skill scans your repository structure, classifies the project, and produces structured markdown artifacts covering architecture, source tree, and deployment. It tracks scan state to support resumable workflows across multi-part codebases.

What is the best way to create AI-ready project knowledge from an undocumented codebase?

AI-ready project knowledge is created by reading repository metadata and resolving customization layers to generate validated markdown documentation. This Skill outputs index, overview, source tree, architecture, development, and optional API documentation artifacts for your codebase.

Can I resume a repository analysis workflow if the documentation scan is interrupted?

Yes, you can resume an interrupted repository analysis scan. This Skill tracks scan state and supports both resume and fresh start workflows, keeping high-level findings available so you can continue documenting a brownfield codebase without losing progress.

Does this project documentation generator work with multi-part codebases?

Yes, this project documentation generator works with multi-part codebases. It detects repository structure, identifies distinct project parts, and chooses the appropriate documentation path to map the full source tree and architecture for each component.

What documentation artifacts are generated when scanning a brownfield repository?

Scanning a brownfield repository generates markdown documentation artifacts including an index, project overview, source tree mapping, architecture documentation, development setup, deployment guides, and optional API or data documentation depending on the codebase.