bmad-document-project

Scans project codebases to generate architecture and component documentation.

15|2|Updated Apr 15, 2026
One-click install
npx skills add https://github.com/lorenzogm/bmad-ui --skill bmad-document-project-lorenzogm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/lorenzogm/bmad-ui/tree/main/.cursor/skills/bmad-document-project
Command: npx skills add https://github.com/lorenzogm/bmad-ui --skill bmad-document-project-lorenzogm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, jinja2, pandas, yamllib, requests, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the documentation of brownfield projects, enabling quick and efficient creation of comprehensive documentation for AI integration.

Core Features & Use Cases

  • Automated Documentation: Generates detailed documentation for brownfield projects, including architecture, component inventories, and development guides.
  • Customizable Workflows: Allows users to select scan levels (quick, deep, exhaustive) and target specific areas for deep-dive documentation.
  • Documentation Requirements: Utilizes a CSV file to define project types and associated documentation requirements.

Quick Start

Use the 'bmad-document-project' skill to document the project in the 'project-root' directory with a quick scan and write the output to the 'project-knowledge' directory.

Frequently Asked Questions about bmad-document-project

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate documentation for an existing codebase?

You can automate existing codebase documentation by running an initial scan to identify technologies and architecture, which then generates comprehensive documentation including architecture and component inventories using Python and Jinja2.

Can I generate deep-dive project documentation for specific areas?

Yes, deep-dive project documentation for specific areas is generated by selecting exhaustive scan levels to target specific directories or components, producing comprehensive analysis outputs without scanning the entire project structure.

Does Python project documentation generation work with Jinja2 and pandas?

Python project documentation generation works with Jinja2 and pandas, alongside yamllib and requests, which are required dependencies for parsing code, analyzing project structure, and rendering documentation templates.

What is the best way to create AI integration documentation for a brownfield project?

The best way to create AI integration documentation for a brownfield project is to use automated scanning to identify existing technologies and architecture, generating development guides and component inventories required for AI integration.

How do I define project documentation requirements using a CSV file?

To define project documentation requirements using a CSV file, map project types to specific documentation needs; the Skill utilizes this CSV input to determine required architecture and development guides for each identified project type.

When should I not use automated code analysis for project documentation?

Automated code analysis for project documentation should not be used when the project lacks a clear directory structure or required dependencies like Python, Jinja2, pandas, yamllib, and requests, which are necessary for parsing and rendering.