bmad-document-project

Automate documentation and classification of brownfield software projects.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, python-pip, python-dev, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the documentation of brownfield projects, providing a comprehensive and contextually rich description of the project for AI-driven understanding and decision-making.

Core Features & Use Cases

  • Project Classification: Automatically classify project types and identify their technology stack.
  • Comprehensive Documentation: Generate detailed documentation including source tree analysis, architecture diagrams, and integration details.
  • Deep-Dive Analysis: Perform an exhaustive analysis of specific project areas or modules for detailed documentation.
  • Resume/Start Workflow: Resume or start fresh based on existing documentation and project context.
  • Multi-Part Project Support: Handle monolithic, monorepo, and multi-part project structures.

Quick Start

Run the skill and follow the prompts to document your project. You can select a specific area for deep-dive analysis or start from scratch with the initial scan.

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

You can automate brownfield project documentation by running this skill to scan your codebase, classify the project type, and generate detailed architecture diagrams and source tree analysis for AI context.

What is deep dive analysis for legacy system documentation?

Deep dive analysis for legacy systems exhaustively examines specific project modules to generate detailed documentation. It targets individual areas within brownfield codebases rather than providing only a high-level overview.

Do I need Python to generate project documentation from source code?

Yes, you need Python to generate project documentation with this tool. The analysis and documentation scripts require Python, python-pip, and python-dev to resolve dependencies and scan source trees.

Does this project documentation tool work with monorepo structures?

Yes, this project documentation tool supports monorepo structures. It handles monolithic, monorepo, and multi-part project architectures to automate comprehensive documentation across complex codebases.

Can I resume a project documentation workflow after stopping?

Yes, you can resume a project documentation workflow after stopping. The tool detects existing documentation and project context, allowing you to resume the analysis or start fresh from the initial scan.

What is the best way to classify a legacy project's technology stack?

The best way to classify a legacy project's technology stack is through automated source tree analysis. This skill scans the codebase to automatically identify project types and map the full technology stack for documentation.