Skill1.3k repo starsupdated today

project-documentation

The project-documentation Claude Code skill generates comprehensive technical documentation by scanning project structure, analyzing source trees, and creating Mermaid architecture diagrams. Use this skill when onboarding new team members, establishing project baselines, or creating deep-dive component documentation that includes source inventories and navigation indexes.

View source Repository: babysitter

Install in Claude Code

Copy

git clone --depth 1 https://github.com/a5c-ai/babysitter /tmp/project-documentation && cp -r /tmp/project-documentation/library/methodologies/bmad-method/skills/project-documentation ~/.claude/skills/project-documentation

Then start a new Claude Code session; the skill loads automatically.

Definition

SKILL.md

# 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