bmad-document-project

Document brownfield projects into structured Markdown files for developers and AI.

Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ImaginerLabs/skill-manager --skill bmad-document-project-imaginerlabs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/ImaginerLabs/skill-manager/tree/main/.trae/skills/bmad-document-project
Command: npx skills add https://github.com/ImaginerLabs/skill-manager --skill bmad-document-project-imaginerlabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams and AI agents generate comprehensive, resume-capable documentation for existing (brownfield) codebases so that knowledge is captured, reproducible, and actionable for architecture review, feature planning, and onboarding.

Core Features & Use Cases

  • Resumable Scans & State Tracking: Initializes and maintains a project-scan-report.json to allow pausing and resuming long analyses across quick, deep, and exhaustive modes.
  • Batched File Reading & Deep-Dive Workflows: Supports batched processing of large repositories, exhaustive per-file deep-dive analysis, dependency graphs, and data-flow tracing to produce deep-dive reports and per-part architecture docs.
  • Validated Outputs & Templates: Writes and validates markdown artifacts (index.md, architecture.md, api-contracts.md, deep-dive-*.md) using provided templates and checklist-driven validation to ensure generated docs are immediately useful.
  • Use Case: Run an exhaustive deep-dive on a monorepo to produce per-part architecture files, API contracts, and a deep-dive analysis of a critical feature folder for planning a brownfield PRD.

Quick Start

Run an exhaustive scan of the repository to generate an AI-friendly documentation index and deep-dive reports.

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 codebase?

To generate documentation for an existing brownfield codebase, run an initial project scan to analyze the source tree and produce structured markdown artifacts like index.md and architecture.md for immediate developer and AI consumption.

Can I pause and resume a deep-dive repository scan for large monorepos?

Yes, you can pause and resume a deep-dive repository scan by leveraging stateful workflow tracking. The process maintains a project-scan-report.json file, allowing batched file processing to be safely stopped and resumed across quick, deep, or exhaustive modes.

What is the best way to extract API contracts from a multi-part repository?

The best way to extract API contracts from a multi-part repository is to perform an exhaustive scan that supports batched file reading and dependency graph tracing, outputting validated machine-readable api-contracts.md files for architecture review.

Does this brownfield project documentation tool support monoliths and multi-part repositories?

Yes, this brownfield project documentation tool supports both monoliths and multi-part repositories. It generates per-part architecture files and exhaustive per-file deep-dive reports tailored to the specific structure of your codebase during full rescans.

What formats are output when scanning a source tree for architecture summaries?

When scanning a source tree for architecture summaries, the outputs are validated markdown files including index.md, architecture.md, api-contracts.md, and specific deep-dive-*.md reports, generated using provided templates and checklist-driven validation.

When do I need an exhaustive deep-dive analysis for a brownfield PRD?

You need an exhaustive deep-dive analysis for a brownfield PRD when planning new features on top of an existing codebase, as it traces data flows and dependencies to produce actionable insights and per-part architecture docs for feature planning.