skills.rest
Cbanzaime23
Cbanzaime23COMMUNITY
Explore all skills by this author →
WebsiteGitHub

bmad-document-project

Generate architecture, data model, API contract, and deployment documentation for brownfield projects.

Updated Sep 27, 2025
Search Tags:#architecture#documentation#brownfield#ai-context#data-models#project-docs#api-contracts
One-click install
npx skills add https://github.com/Cbanzaime23/Booking-System --skill bmad-document-project-cbanzaime23
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/Cbanzaime23/Booking-System/tree/main/.agent/skills/bmad-document-project
Command: npx skills add https://github.com/Cbanzaime23/Booking-System --skill bmad-document-project-cbanzaime23

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document brownfield projects for AI context, enabling AI-ready knowledge capture and consistent prompts.

Core Features & Use Cases

  • Automates generation of comprehensive project docs from codebases and artifacts.
  • Produces structured documentation (architecture, data models, API contracts) for onboarding, audits, and future work.
  • Use Case: When a legacy project needs AI-ready context for planning brownfield PRD, this skill generates standardized docs and summaries.

Quick Start

Document a given project by running the BMAD document-project workflow to generate a full set of architecture, API, data models, and deployment docs.

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 AI context for legacy brownfield projects?▼

To generate AI context for legacy brownfield projects, you can automate the extraction of architecture, data models, and API contracts into a structured, machine-readable index for AI agents.

What documentation is needed for brownfield PRD workflows?▼

Brownfield PRD workflows require structured documentation covering architecture, data models, API contracts, deployment guidelines, and integration points to provide knowledge-rich prompts for AI agents.

How do I document API contracts and data models for AI agents?▼

Document API contracts and data models for AI agents by running an automated workflow that analyzes your codebase and supporting docs to produce a standardized, machine-readable index.

Can I use automated documentation generation for multi-part repositories?▼

Yes, automated documentation generation applies specifically to multi-part repositories with legacy code, detecting the technology stack and extracting data models and API contracts for AI-ready context.

What is the best way to provide consistent prompts for AI agents in software engineering?▼

The best way to provide consistent prompts for AI agents is to generate standardized project documentation that captures architecture, API contracts, and deployment configurations in a machine-readable format.

Related Skills

Explore More Software Engineering Skills→
Rinzler78Rinzler78
1

bmad-document-project

Classify repository structure and generate markdown documentation for brownfield projects.

Community
Advanced
heyJordanParkerheyJordanParker
20

ralph-tui-prd

Generates structured PRDs with iterative clarifying questions for the ralph-tui workflow.

Community
Advanced
Gingi892Gingi892

n8n-workflow-patterns

Design scalable n8n workflows using five architectural patterns and validate configurations.

Community
Advanced
anderson-0anderson-0
4

architecture-map

Generate Mermaid architecture diagrams from source code with dependency analysis.

Community
Advanced