Project Documentation
Generate comprehensive project documentation with source tree analysis and Mermaid diagrams.
Best use case
Project Documentation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Generate comprehensive project documentation with source tree analysis and Mermaid diagrams.
Teams using Project Documentation should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/project-documentation/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How Project Documentation Compares
| Feature / Agent | Project Documentation | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Generate comprehensive project documentation with source tree analysis and Mermaid diagrams.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
Best AI Skills for ChatGPT
Find the best AI skills to adapt into ChatGPT workflows for research, writing, summarization, planning, and repeatable assistant tasks.
AI Agent for SaaS Idea Validation
Use AI agent skills for SaaS idea validation, market research, customer discovery, competitor analysis, and documenting startup hypotheses.
SKILL.md Source
# 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
Related Skills
project-install
Install the Babysitter Codex workspace integration into the current project.
clinical-documentation-query
Generate compliant physician queries to clarify clinical documentation for accurate coding, severity of illness, and risk of mortality capture
collection-documentation
Create and maintain comprehensive collection records including cataloging, photography, condition documentation, and database management following AAM/ICOM standards
project-charter-generator
Generate project charter documents with comprehensive project definition elements
dmaic-project-manager
DMAIC methodology execution skill with tollgate reviews, documentation templates, and project tracking
marketing-project-management
Marketing workflow and project management integration
pip-documentation
Create legally compliant performance improvement plan documentation with evidence tracking and milestone management
tauri-project-setup
Initialize Tauri project with Rust backend and frontend framework integration
qt-cmake-project-generator
Generate CMake-based Qt project with proper module dependencies, cross-compilation support, and modern Qt6 configuration
maui-project-generator
Generate .NET MAUI project with platform-specific handlers for desktop and mobile
dbt-project-analyzer
Analyzes dbt projects for best practices, performance, maintainability, and generates actionable recommendations for improvement.
documentation-generator
Generate documentation for migrated systems including API docs, architecture docs, and runbooks