Templates Reference
Templates define the structure of artifacts produced by SNIPER agents during phase execution. They ensure consistent output format across projects. Templates are stored in .sniper/templates/ as markdown or YAML files.
Artifact Templates
Discovery Phase
| Template | File | Produced By | Description |
|---|---|---|---|
| Brief | brief.md | Analyst | Project brief with objectives, users, scope, and risks |
| Personas | personas.md | Analyst | User persona definitions |
| Risks | risks.md | Analyst | Risk assessment with severity and mitigations |
Planning Phase
| Template | File | Produced By | Description |
|---|---|---|---|
| PRD | prd.md | Product Manager | Product requirements with user stories and acceptance criteria |
| Architecture | architecture.md | Architect | System architecture with diagrams, data models, and API design |
| UX Spec | ux-spec.md | UX Designer | User experience specification with flows and wireframes |
| Security | security.md | Security Analyst | Security requirements, threat model, and mitigations |
Solve Phase
| Template | File | Produced By | Description |
|---|---|---|---|
| Epic | epic.md | Scrum Master | Epic definition with scope, stories, and dependencies |
| Story | story.md | Scrum Master | Self-contained story with embedded context and acceptance criteria |
| Conventions | conventions.md | Scrum Master | Coding conventions extracted during story creation |
Sprint Phase
| Template | File | Produced By | Description |
|---|---|---|---|
| Sprint Review | sprint-review.md | QA Engineer | Sprint completion report with test results |
Documentation Phase
| Template | File | Produced By | Description |
|---|---|---|---|
| README | doc-readme.md | Doc Writer | Project README |
| API Docs | doc-api.md | Doc Writer | API documentation |
| Guide | doc-guide.md | Doc Writer | User guide |
Feature Lifecycle
| Template | File | Produced By | Description |
|---|---|---|---|
| Feature Brief | feature-brief.md | Feature scoping | Feature scope definition |
| Feature Spec | feature-spec.md | Feature planning | Feature specification with architecture delta |
| Arch Delta | arch-delta.md | Feature planning | Architecture changes for merge-back |
Debug Workflow
| Template | File | Produced By | Description |
|---|---|---|---|
| Bug Report | bug-report.md | Triage Lead | Structured bug report |
| Investigation | investigation.md | Code Investigator | Root cause analysis |
| Postmortem | postmortem.md | Debug team | Post-incident analysis |
Audit Workflow
| Template | File | Produced By | Description |
|---|---|---|---|
| PR Review | pr-review.md | Code Reviewer | Pull request review report |
| Refactor Scope | refactor-scope.md | Migration Architect | Refactoring plan and scope |
| Coverage Report | coverage-report.md | Coverage Analyst | Test coverage analysis |
| Flaky Report | flaky-report.md | Flake Hunter | Flaky test identification report |
| Threat Model | threat-model.md | Threat Modeler | Security threat model |
| Vulnerability Report | vulnerability-report.md | Vuln Scanner | Vulnerability scan results |
| Performance Profile | performance-profile.md | Perf Profiler | Performance profiling results |
| Optimization Plan | optimization-plan.md | Perf Profiler | Performance optimization recommendations |
| Migration Plan | migration-plan.md | Migration Architect | Migration execution plan |
| Release Readiness | release-readiness.md | Release Manager | Release readiness assessment |
Workspace Mode
| Template | File | Produced By | Description |
|---|---|---|---|
| Workspace Brief | workspace-brief.md | Workspace Orchestrator | Cross-repo feature scope |
| Workspace Plan | workspace-plan.md | Workspace Orchestrator | Cross-repo implementation plan |
| Contract | contract.yaml | Contract Designer | Interface contract definition (YAML) |
| Contract Validation Report | contract-validation-report.md | Integration Validator | Contract compliance results |
Memory
| Template | File | Description |
|---|---|---|
| Convention | memory-convention.yaml | Convention entry format |
| Anti-Pattern | memory-anti-pattern.yaml | Anti-pattern entry format |
| Decision | memory-decision.yaml | Decision entry format |
| Retro | retro.yaml | Sprint retrospective format |
Template Usage
Templates are automatically used by agents during phase execution. The agent reads the template, fills in project-specific content, and writes the artifact to the docs/ directory.
TIP
Templates define structure, not content. Agents use them as scaffolding and fill in details based on the project context, prior artifacts, and their persona expertise.
Domain Pack Templates
Domain packs can provide additional templates or template addenda that extend standard templates with domain-specific sections. See Domain Packs for details.
Related
- Core Concepts -- artifacts and how they fit the lifecycle
- Full Lifecycle -- which templates are used in each phase
- Teams -- which agents produce which artifacts