Назад към всички

project-documentation

// Generate comprehensive project documentation with source tree analysis and Mermaid diagrams.

$ git log --oneline --stat
stars:384
forks:73
updated:March 4, 2026
SKILL.mdreadonly

Project Documentation

Generate comprehensive project documentation with source tree analysis and Mermaid diagrams.

Agent

Paige (Tech Writer) - bmad-writer-paige

Workflow

  1. Scan project structure and identify components
  2. Analyze source tree with annotations
  3. Generate project context for onboarding
  4. Create deep-dive component documentation
  5. Generate Mermaid architecture diagrams
  6. Build documentation index with navigation

Inputs

  • projectName - Project name
  • projectPath - Path to project root
  • documentationType - full-scan, deep-dive, or context-only

Outputs

  • Scan report with component inventory
  • Annotated source tree
  • Project overview and onboarding guide
  • Deep-dive component documentation
  • Documentation index

Process Files

  • bmad-document-project.js - Standalone documentation
  • bmad-orchestrator.js - Final documentation phase