Skip to content

Templates Reference

Templates define the structure of artifacts produced by SNIPER agents during protocol execution. They ensure consistent output format across projects. Templates are stored in .sniper/templates/.

Available Templates

Core Artifacts

TemplateFormatDescription
ArchitectureMarkdownSystem architecture with diagrams, data models, and API design
SpecificationMarkdownProject specification with requirements and acceptance criteria
StoryMarkdownSelf-contained story with embedded context and acceptance criteria
Codebase OverviewMarkdownOverview of existing codebase structure and patterns

Review & Quality

TemplateFormatDescription
Review ReportMarkdownPhase review gate results and scoring
Multi-Faceted Review ReportMarkdownThree-dimension review: scope, standards, risk

Runtime State

TemplateFormatDescription
CheckpointYAMLPhase checkpoint — snapshot of protocol state
Live StatusYAMLReal-time protocol progress

Signals & Knowledge

TemplateFormatDescription
Signal RecordYAMLCaptures learning from CI failures, PR reviews, production errors
Knowledge ManifestYAMLDomain knowledge sources for agent injection

Workspace & Configuration

TemplateFormatDescription
Workspace ConfigYAMLMulti-project workspace configuration
Custom ProtocolYAMLCustom protocol definition template

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 .sniper/ 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 role.