bmad-document-project

Generate project documentation via Python scripts with structure and stack analysis.

1|Updated Apr 27, 2026
One-click install
npx skills add https://github.com/peshay/portfolixir --skill bmad-document-project-peshay
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/peshay/portfolixir/tree/main/.claude/skills/bmad-document-project
Command: npx skills add https://github.com/peshay/portfolixir --skill bmad-document-project-peshay

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, pypdf2, requests, textract, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the documentation of brownfield projects, providing AI context for better understanding and management.

Core Features & Use Cases

  • Automated Documentation: Generates comprehensive documentation for projects, including architecture, source tree, development and operational information.
  • Deep Dive Analysis: Performs in-depth analysis of specific areas or files within the project.
  • Documentation Resumption: Allows resumption of documentation process from a previous state.

Quick Start

Use the bmad-document-project skill to generate documentation for the project at the root directory '/path/to/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 brownfield projects?

Automating project documentation for brownfield projects requires Python scripts that detect project structure, analyze the technology stack, and generate comprehensive architecture and source tree documentation for AI context.

What is AI context generation for existing codebases?

AI context generation for existing codebases is the process of analyzing project structure and technology stack to produce documentation that helps AI systems understand and manage brownfield project architecture and operations.

Does this project documentation tool require specific Python dependencies?

Project documentation generation requires Python along with pypdf2, requests, and textract dependencies to analyze files and extract text for comprehensive project structure detection and technology stack analysis.

Can I resume project documentation generation from a previous state?

Project documentation generation can be resumed from a previous state, allowing you to continue the analysis of specific areas or files within the project without restarting the entire process.

How do I perform deep dive analysis on specific project files?

Deep dive analysis on specific project files is performed by configuring the Python scripts to target specific areas within the project, generating detailed documentation based on project type requirements.

What is the best way to document a technology stack for AI management?

Documenting a technology stack for AI management involves automated scripts that detect the project structure, analyze the stack, and generate development and operational information tailored to the project type.