skills.rest
devalexanderdaza
devalexanderdazaCOMMUNITY
Explore all skills by this author →
Website𝕏@devalexanderdazGitHub

bmad-document-project

Generate architecture documentation, API contracts, and data models from existing source code.

Updated May 5, 2026
Search Tags:#architecture#documentation#brownfield#ai-context#api-contracts#deep-dive#project-scan
One-click install
npx skills add https://github.com/devalexanderdaza/bmad-any --skill bmad-document-project-devalexanderdaza
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/devalexanderdaza/bmad-any/tree/main/.agents/skills/bmad-document-project
Command: npx skills add https://github.com/devalexanderdaza/bmad-any --skill bmad-document-project-devalexanderdaza

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documenting existing brownfield projects for AI-assisted development requires manually analyzing codebases, extracting architecture patterns, and maintaining context across multiple files. This Skill automates that entire process, transforming raw source code into structured, AI-readable documentation without manual effort.

Core Features & Use Cases

  • Intelligent Project Scanning: Detects project type, technology stack, and architecture patterns using pattern matching and conditional file analysis across web, mobile, backend, CLI, and other project types.
  • Comprehensive Documentation Generation: Produces architecture docs, API contracts, data models, source tree analysis, component inventories, and development guides from actual codebase analysis.
  • Resumable Workflow Modes: Supports quick pattern-based scans, deep selective reads, and exhaustive full-codebase analysis with state persistence, allowing interrupted workflows to resume exactly where they left off.

Quick Start

Use the bmad-document-project skill to generate complete documentation for your existing project by simply asking it to document 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 architecture documentation for an existing brownfield codebase?▼

To generate architecture documentation for a brownfield codebase, trigger a project scan to automatically analyze source code and configuration files, producing structured architecture docs, API contracts, and data models without manual extraction.

What is the best way to provide AI context for an existing software project?▼

Providing AI context for an existing software project involves scanning the source tree to extract technology stack patterns and API definitions, generating comprehensive AI-readable development guides that capture the architectural state of the codebase.

Can I document specific modules instead of running a full codebase scan?▼

Yes, you can document specific modules by using deep-dive analysis mode, which selectively reads targeted features within client, server, or full-stack codebases rather than executing an exhaustive full-codebase scan.

Does the project scan work across different technology stacks and frameworks?▼

Project scanning works across web, mobile, backend, and CLI technology stacks by using pattern matching and conditional file analysis to detect project types and architecture patterns automatically.

What happens if a full codebase analysis workflow is interrupted?▼

If a full codebase analysis is interrupted, the workflow uses state persistence to save progress, allowing resumable workflows to resume exactly where they left off without needing to restart the scan.

Related Skills

Explore More Software Engineering Skills→
adacosdevadacosdev

sdd-init

Detect tech stack and initialize Spec-Driven Development context for a project.

Community
Advanced
Happyverse-TeamHappyverse-Team

codebase-summary

Analyze a codebase and generate architecture and workflow documentation.

Official
Advanced
archyl-comarchyl-com
1

archyl-review

Analyze code changes against Archyl's C4 model and conformance rules.

Official
Advanced
aditya30103aditya30103

audit

Audit codebases for async races, cache consistency, and regression-prone patterns.

Community
Advanced