bmad-document-project

Analyze source code structures and generate architecture, API, and development guides.

Updated Jul 11, 2026
One-click install
npx skills add https://github.com/marcmontecalvo/kinward --skill bmad-document-project-marcmontecalvo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/marcmontecalvo/kinward/tree/main/.agents/skills/bmad-document-project
Command: npx skills add https://github.com/marcmontecalvo/kinward --skill bmad-document-project-marcmontecalvo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3, and includes scripts (resource) components.

What problem does it solve?

This skill solves the challenge of maintaining up-to-date, comprehensive documentation for existing brownfield projects by automating the discovery, analysis, and generation of technical artifacts.

Core Features & Use Cases

  • Exhaustive Project Analysis: Performs deep-dive scans of source code to map dependencies, data flows, and architecture patterns.
  • Automated Documentation Generation: Creates a full suite of project docs including architecture, API contracts, and component inventories.
  • Resumable Workflows: Tracks scan progress in a state file, allowing for interrupted documentation tasks to be resumed without losing context.

Quick Start

Activate the bmad-document-project skill and follow the interactive prompts to initiate a full project scan or a deep-dive into a specific module.

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 brownfield codebase?

Automated brownfield documentation uses resumable scan workflows that track progress in a state file, allowing interrupted analysis and codebase mapping tasks to resume without losing context.

Can I customize automated architecture documentation rules for my specific project?

Automated codebase analysis maps dependencies, data flows, and architecture patterns to generate a full suite of technical artifacts including API contracts and component inventories.

Does automated project documentation require Python 3 to run?

Resumable documentation workflows track scan progress in a persistent state file, ensuring that interrupted codebase analysis or technical artifact generation can be resumed seamlessly.

What is the best way to generate API and component inventories from source code?

Generate API and component inventories by performing exhaustive project analysis that scans source code to map dependencies and data flows, then outputs comprehensive technical guides.