skills.rest
sfines
sfinesCOMMUNITY
Explore all skills by this author →
GitHub

bmad-document-project

Generate documentation for brownfield projects by analyzing files, dependencies, and architecture.

1|Updated May 31, 2026
Search Tags:#code analysis#project documentation#architecture documentation#integration analysis#brownfield documentation
One-click install
npx skills add https://github.com/sfines/slf-llm-wiki-py --skill bmad-document-project-sfines
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/sfines/slf-llm-wiki-py/tree/main/.agents/skills/bmad-document-project
Command: npx skills add https://github.com/sfines/slf-llm-wiki-py --skill bmad-document-project-sfines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, uv, jsonschema, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the documentation of brownfield projects, enabling efficient capture of project context, architecture, and integration details for AI-driven workflows.

Core Features & Use Cases

  • Project Documentation: Automatically generate documentation for brownfield projects.
  • Documentation Scanning: Perform quick, deep, or exhaustive scans of project files and dependencies.
  • Integration Analysis: Document API endpoints, data models, and UI components.
  • Documentation Generation: Create comprehensive documentation for architecture, source tree, development, and deployment.

Quick Start

Use the bmad-document-project skill to generate documentation for a 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 codebases?▼

Analyze API endpoints, data models, and UI components by running integration analysis scans on the existing project. This Skill parses project files and dependencies to automatically document integration points and architecture for AI context.

What is the best way to document architecture and integration points for an existing project?▼

To document architecture and integration points, perform deep or exhaustive scans of project files and dependencies. This Skill outputs comprehensive architecture and integration documentation for existing projects.

Do I need Python to generate brownfield project documentation?▼

Yes, Python is required along with the uv and jsonschema libraries to execute file parsing and analysis. These dependencies enable the automated scanning and generation of project documentation.

Can I perform a quick scan of project files and dependencies for documentation?▼

Yes, you can perform quick, deep, or exhaustive scans of project files and dependencies. This flexibility allows you to control the depth of project documentation and integration analysis based on your needs.

How does automated documentation handle technology stack analysis for AI workflows?▼

Automated documentation handles technology stack analysis by parsing project files and dependencies to extract architecture details. It generates structured documentation that provides efficient project context for AI-driven workflows.

Related Skills

Explore More Software Engineering Skills→
AutumnsGroveAutumnsGrove

uv-package-manager

Automates Python project setup, dependency management and virtual environments using UV commands.

Community
Advanced
majiayu000majiayu000
37

eval-harness

Quantify AI-generated code quality using pass@k and pass^k metrics.

Community
Advanced
cwilliams5cwilliams5
1

review-tool-coverage

Audit query tools for accuracy, coverage gaps, and retirement candidates.

Community
Intermediate
drsapaevdrsapaev
2

aif-architecture

Generate architecture guidelines and a detailed ARCHITECTURE.md file for software projects.

Community
Intermediate