skills.rest
thavirak-svay
thavirak-svayCOMMUNITY
Explore all skills by this author →
GitHub

bmad-document-project

Generate architecture, component, and integration documentation for brownfield projects.

1|Updated Feb 25, 2026
Search Tags:#codebase analysis#project documentation#architecture documentation#AI-assisted documentation#brownfield project
One-click install
npx skills add https://github.com/thavirak-svay/rentify-backend --skill bmad-document-project-thavirak-svay
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/thavirak-svay/rentify-backend/tree/main/_bmad/bmm/workflows/bmad-document-project
Command: npx skills add https://github.com/thavirak-svay/rentify-backend --skill bmad-document-project-thavirak-svay

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the documentation of brownfield projects, making them easier to understand and work with for AI systems.

Core Features & Use Cases

  • Project Documentation: Automatically generates comprehensive documentation for a given project, including architecture, components, and integration details.
  • Scalability: Handles monolithic, monorepo, and multi-part projects of varying complexity.
  • Customization: Allows users to perform deep-dive analysis on specific areas of the project.
  • Output Generation: Generates a variety of documentation files, including source tree analysis, architecture documentation, and development guides.

Quick Start

To begin, use the bmad-document-project skill with the command: 'document this 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 automate project documentation for an existing codebase?▼

Automate project documentation by scanning your codebase to capture the technology stack, architecture, and codebase organization, generating comprehensive documentation files using predefined templates.

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

Brownfield project documentation captures details of existing projects to make them easier to understand and work with for AI systems. You need it when onboarding AI to an established codebase.

Can I generate architecture documentation for monorepo or multi-part projects?▼

Yes, project documentation generation handles monolithic, monorepo, and multi-part projects of varying complexity, scaling to capture architecture and integration details across the entire codebase.

How do I perform a deep-dive analysis on specific areas of my project?▼

Perform a deep-dive analysis by customizing the documentation process to target specific areas of your project, parsing project metadata to generate focused source tree analysis and development guides.

Does AI-assisted documentation require initial scanning before generating files?▼

Yes, AI-assisted documentation requires initial scanning to parse project metadata. It supports initial scanning, full rescan, and deep-dive analysis to accurately capture components and integration details.

What types of documentation files are generated for a codebase analysis?▼

Codebase analysis generates a variety of documentation files, including source tree analysis, architecture documentation, and development guides based on predefined templates.

Related Skills

Explore More Software Engineering Skills→
securityreviewaisecurityreviewai

project-overview-analysis

Analyzes Git repositories to produce summaries of their structure, risks, and key components.

Official
Intermediate
geekdesign27geekdesign27

bmad-document-project

Generate architecture diagrams, source tree analysis, and API contracts for brownfield projects.

Community
Advanced
apexradiusapexradius

context-driven-development

Generate and maintain structured project context artifacts for AI-assisted development.

Official
Advanced
Happyverse-TeamHappyverse-Team

codebase-summary

Analyze a codebase and generate architecture and workflow documentation.

Official
Advanced