bmad-document-project

Generate project documentation from codebase structure and tech stacks.

Updated Mar 24, 2026

Search Tags:#workflow #architecture #documentation #PRD #brownfield #document #ai-context

Ready to run

npx skills add https://github.com/imonmi/INTER-EDU --skill bmad-document-project-imonmi

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/imonmi/INTER-EDU/tree/main/_bmad/bmm/workflows/bmad-document-project
Command: npx skills add https://github.com/imonmi/INTER-EDU --skill bmad-document-project-imonmi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Brownfield initiatives often lack centralized, AI-contextual documentation. This Skill provides a repeatable workflow to generate comprehensive project documentation from an existing codebase, ensuring consistency and enabling faster brownfield PRD decisions.

Core Features & Use Cases

Automated project discovery: Detects repository structure, identifies parts, and infers the tech stack to tailor documentation.
Multi-part support: Documents monoliths, multi-part repos, and federated architectures with per-part reports and a master index.
Comprehensive outputs: Generates project overview, architecture, source-tree analysis, per-part reports, and optional deep-dive documentation.

Quick Start

Trigger the workflow on your repository to begin documenting 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 codebase to use as AI context?▼

To generate AI context documentation for an existing codebase, trigger an automated workflow that analyzes repository structure, detects tech stacks, and produces per-part reports with a master index. This ensures structured artifacts suitable for review and iteration.

What is brownfield project documentation and when do I need it?▼

Brownfield project documentation provides centralized, AI-contextual records for existing codebases. You need it when initiating brownfield PRD workflows that lack consistent documentation, enabling faster product decisions and AI context generation.

Can I document multi-part repositories and federated architectures using an automated workflow?▼

Yes, this workflow supports multi-part repositories and federated architectures by detecting distinct parts, inferring their tech stacks, and generating tailored per-part reports alongside a comprehensive master index.

How do I create a master index and project overview from a monolithic repository?▼

You can create a master index and project overview by running an automated discovery process that analyzes repository structure and source-tree, automatically generating comprehensive architecture documentation and per-part reports.

Does the documentation workflow support resumable state for large repositories?▼

Yes, the documentation workflow ensures resumable state, allowing you to pause and resume the analysis of large repositories. It maintains clear outputs and structured artifacts throughout the process.

What's the best way to perform deep-dive documentation on targeted areas of a codebase?▼

The best way to perform deep-dive documentation is using an automated workflow that generates optional deep-dive reports for targeted areas, ensuring structured artifacts that support resumable state and iterative review.