Project Documentation
Scannednpx machina-cli add skill a5c-ai/babysitter/project-documentation --openclawProject Documentation
Generate comprehensive project documentation with source tree analysis and Mermaid diagrams.
Agent
Paige (Tech Writer) - bmad-writer-paige
Workflow
- Scan project structure and identify components
- Analyze source tree with annotations
- Generate project context for onboarding
- Create deep-dive component documentation
- Generate Mermaid architecture diagrams
- Build documentation index with navigation
Inputs
projectName- Project nameprojectPath- Path to project rootdocumentationType- 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 documentationbmad-orchestrator.js- Final documentation phase
Source
git clone https://github.com/a5c-ai/babysitter/blob/main/plugins/babysitter/skills/babysit/process/methodologies/bmad-method/skills/project-documentation/SKILL.mdView on GitHub Overview
Project Documentation automates thorough documentation of codebases by analyzing the source tree, generating an onboarding-friendly context, and producing Mermaid architecture diagrams. It outputs a scan report, annotated tree, a project overview, deep-dive component docs, and a navigable index to help teams understand and hand off projects efficiently.
How This Skill Works
Given inputs like projectName, projectPath, and documentationType, the skill scans the project structure, annotates the source tree, and generates a project context for onboarding. It then creates deep-dive component documentation, Mermaid diagrams, and a documentation index, all orchestrated by bmad-document-project.js and bmad-orchestrator.js.
When to Use It
- Onboarding new team members to a codebase
- Documenting a legacy/repo with annotated source structure
- Preparing a handover for stakeholders or new teams
- Generating Mermaid architecture diagrams for reviews
- Creating a searchable documentation index and onboarding guide
Quick Start
- Step 1: Run bmad-document-project.js to scan the project and annotate the source tree
- Step 2: Run bmad-orchestrator.js to generate the final documentation, diagrams, and index
- Step 3: Review the project overview, onboarding guide, and Mermaid diagrams before publishing
Best Practices
- Define projectName, projectPath, and documentationType upfront to standardize outputs
- Run a full-scan before deep-dives to ensure component inventory is accurate
- Annotate important components and add context notes in the source tree
- Verify Mermaid diagrams render correctly and stay in sync with the docs
- Regularly update the documentation index after changes or releases
Example Use Cases
- Documenting a monolithic app to onboard new engineers with an annotated tree and diagrams
- Generating a backend service documentation suite for an API gateway project
- Creating a developer handbook for a plugin-based project
- Producing an architecture diagram bundle for a microservices re-architecture
- Building a project overview and onboarding guide for a new feature area
