Installable skillMIT

Project Documentation

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

BY a5c-aiUPDATED Oct 27, 2026
INTENDED FOR◈OpenClawInstall in a listed agent.

instructions.md

---
name: project-documentation
graph:
  domains: [domain:software-engineering]
  skillAreas: [skill-area:agentic-loops, skill-area:orchestration-loop]
  workflows: [workflow:feature-development]
  topics: [topic:developer-experience]
  roles: [role:tech-lead, role:backend-engineer]
---

# 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
COMPATIBILITY & REFERENCES

Platform guidance

Imported from the listed AgentSkill.sh category. Complete supplied package files and notices are retained. Required external tools and credentials are not installed. No bundled code was executed during import. Individual agent task behavior has not been tested.