skills.rest
JaronTam
JaronTamCOMMUNITY
Explore all skills by this author →
GitHub

bmad-document-project

Scan and analyze brownfield project structures to generate structured documentation.

Updated May 22, 2026
Search Tags:#workflow automation#codebase analysis#AI-assisted development#project documentation#brownfield analysis
One-click install
npx skills add https://github.com/JaronTam/SDONE --skill bmad-document-project-jarontam
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/JaronTam/SDONE/tree/main/.agents/skills/bmad-document-project
Command: npx skills add https://github.com/JaronTam/SDONE --skill bmad-document-project-jarontam

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the documentation of brownfield projects, providing AI-powered workflows to streamline the process of creating detailed project documentation.

Core Features & Use Cases

  • Comprehensive Project Documentation: Automatically generates documentation including architecture, codebase analysis, and development and operational information.
  • Deep Dive Capabilities: Allows for deep analysis of specific areas within a project for detailed documentation.
  • Scalable Workflow: Supports different project types and sizes, with configurable scan levels for speed and depth.
  • Resumable Workflows: Can resume from where it left off in case of interruption.

Quick Start

Use the bmad-document-project skill to start the documentation process for a project located in the folder '/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 documentation for a brownfield project?▼

To automate brownfield project documentation, this Skill scans and analyzes existing project structures, extracts technical details, and generates structured documentation covering architecture and codebase analysis.

Can I perform deep dive codebase analysis on specific areas of a project?▼

Yes, deep dive codebase analysis allows detailed examination of specific areas within a project. You can configure scan levels to balance speed and depth for generating targeted technical documentation.

Does project documentation generation require Python?▼

Yes, Python is required for scripting and analysis to automate the project documentation generation. The workflow uses Python to scan project structures and extract technical details.

What happens if the AI-assisted documentation workflow is interrupted?▼

If the AI-assisted documentation workflow is interrupted, it features resumable workflows. This allows the process to resume from where it left off, preventing loss of progress during large project analysis.

Is this brownfield analysis tool suitable for large codebases?▼

Yes, this brownfield analysis tool supports different project types and sizes. It features a scalable workflow with configurable scan levels to handle large codebases efficiently.

What is the best way to document architecture and operational information for an existing codebase?▼

The best way to document architecture and operational information is using an AI-driven workflow that automatically scans the codebase, extracts technical details, and generates comprehensive structured documentation.

Related Skills

Explore More Software Engineering Skills→
1m01m01m01m0
6

project-structure-viewer

Generates an interactive HTML project structure map from any codebase using Python 3.10+ scripts.

Community
Advanced
allenaiallenai
30

Asta Artifacts

Export and organize research artifacts into markdown or HTML formats.

Official
Basic
PatrickjoshanedezPatrickjoshanedez

anti-slop

Detect and remove generic AI-generated patterns from text files.

Official
Intermediate
Happyverse-TeamHappyverse-Team

codebase-summary

Analyze a codebase and generate architecture and workflow documentation.

Official
Advanced