sniper-doc
Phase: doc
Team Composition
| Member | Process | Technical | Cognitive | Domain |
|---|---|---|---|---|
| doc-analyst | doc-analyst | -- | user-empathetic | from-config |
| doc-writer | doc-writer | from-config | mentor-explainer | from-config |
| doc-reviewer | doc-reviewer | -- | devils-advocate | -- |
Tasks
doc-analyst
Analyze Project Structure & Artifacts
- ID:
analyze-project - Output:
docs/.sniper-doc-index.json
Scan the codebase and SNIPER artifacts. Produce a documentation index: what exists, what's missing, what's stale. Map source files to documentation topics. Detect whether this is a SNIPER project (has .sniper/config.yaml with completed phases) or a standalone project (codebase analysis only).
doc-writer
Generate README.md
- ID:
write-readme - Output:
README.md - Template:
.sniper/templates/doc-readme.md
Write the project README from artifacts and codebase analysis. Include: overview, quick start, features, tech stack, project structure, contributing link, license. Use the doc index to determine what sources to read.
Generate Documentation Guides
- ID:
write-guides - Output:
docs/ - Template:
.sniper/templates/doc-guide.md
Generate the documentation files requested by the user (setup, architecture, API, deployment, etc.) based on the doc index. Each guide follows the doc-guide template. Use the doc index to determine which guides to generate and what sources to read.
doc-reviewer
Review & Validate Documentation
- ID:
review-docs - Output:
docs/.sniper-doc-review.md
Review all generated docs for accuracy, completeness, and consistency. Verify code examples compile, links resolve, and setup instructions actually work. Produce a review report with PASS/WARN/FAIL for each file.
Review Gate
- Checklist:
.sniper/checklists/doc-review.md - Mode: flexible
