@sniper.ai/core 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -0
- package/framework/checklists/code-review.md +33 -0
- package/framework/checklists/discover-review.md +33 -0
- package/framework/checklists/doc-review.md +39 -0
- package/framework/checklists/plan-review.md +52 -0
- package/framework/checklists/sprint-review.md +41 -0
- package/framework/checklists/story-review.md +30 -0
- package/framework/claude-md.template +37 -0
- package/framework/commands/sniper-compose.md +237 -0
- package/framework/commands/sniper-discover.md +397 -0
- package/framework/commands/sniper-doc.md +441 -0
- package/framework/commands/sniper-init.md +372 -0
- package/framework/commands/sniper-plan.md +608 -0
- package/framework/commands/sniper-review.md +305 -0
- package/framework/commands/sniper-solve.md +375 -0
- package/framework/commands/sniper-sprint.md +601 -0
- package/framework/commands/sniper-status.md +276 -0
- package/framework/config.template.yaml +117 -0
- package/framework/personas/cognitive/devils-advocate.md +30 -0
- package/framework/personas/cognitive/mentor-explainer.md +29 -0
- package/framework/personas/cognitive/performance-focused.md +30 -0
- package/framework/personas/cognitive/security-first.md +29 -0
- package/framework/personas/cognitive/systems-thinker.md +29 -0
- package/framework/personas/cognitive/user-empathetic.md +29 -0
- package/framework/personas/domain/.gitkeep +0 -0
- package/framework/personas/process/analyst.md +29 -0
- package/framework/personas/process/architect.md +30 -0
- package/framework/personas/process/developer.md +32 -0
- package/framework/personas/process/doc-analyst.md +63 -0
- package/framework/personas/process/doc-reviewer.md +62 -0
- package/framework/personas/process/doc-writer.md +42 -0
- package/framework/personas/process/product-manager.md +32 -0
- package/framework/personas/process/qa-engineer.md +31 -0
- package/framework/personas/process/scrum-master.md +31 -0
- package/framework/personas/process/ux-designer.md +31 -0
- package/framework/personas/technical/ai-ml.md +33 -0
- package/framework/personas/technical/api-design.md +32 -0
- package/framework/personas/technical/backend.md +32 -0
- package/framework/personas/technical/database.md +32 -0
- package/framework/personas/technical/frontend.md +33 -0
- package/framework/personas/technical/infrastructure.md +32 -0
- package/framework/personas/technical/security.md +34 -0
- package/framework/settings.template.json +6 -0
- package/framework/spawn-prompts/_template.md +22 -0
- package/framework/teams/discover.yaml +57 -0
- package/framework/teams/doc.yaml +76 -0
- package/framework/teams/plan.yaml +86 -0
- package/framework/teams/solve.yaml +48 -0
- package/framework/teams/sprint.yaml +68 -0
- package/framework/templates/architecture.md +72 -0
- package/framework/templates/brief.md +52 -0
- package/framework/templates/doc-api.md +53 -0
- package/framework/templates/doc-guide.md +35 -0
- package/framework/templates/doc-readme.md +49 -0
- package/framework/templates/epic.md +33 -0
- package/framework/templates/personas.md +118 -0
- package/framework/templates/prd.md +69 -0
- package/framework/templates/risks.md +64 -0
- package/framework/templates/security.md +90 -0
- package/framework/templates/sprint-review.md +32 -0
- package/framework/templates/story.md +37 -0
- package/framework/templates/ux-spec.md +54 -0
- package/framework/workflows/discover-only.md +39 -0
- package/framework/workflows/full-lifecycle.md +56 -0
- package/framework/workflows/quick-feature.md +44 -0
- package/framework/workflows/sprint-cycle.md +47 -0
- package/package.json +30 -0
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
team_name: sniper-doc
|
|
2
|
+
phase: doc
|
|
3
|
+
|
|
4
|
+
teammates:
|
|
5
|
+
- name: doc-analyst
|
|
6
|
+
compose:
|
|
7
|
+
process: doc-analyst
|
|
8
|
+
technical: null
|
|
9
|
+
cognitive: user-empathetic
|
|
10
|
+
domain: from-config
|
|
11
|
+
tasks:
|
|
12
|
+
- id: analyze-project
|
|
13
|
+
name: "Analyze Project Structure & Artifacts"
|
|
14
|
+
output: "docs/.sniper-doc-index.json"
|
|
15
|
+
description: >
|
|
16
|
+
Scan the codebase and SNIPER artifacts. Produce a documentation
|
|
17
|
+
index: what exists, what's missing, what's stale. Map source
|
|
18
|
+
files to documentation topics. Detect whether this is a SNIPER
|
|
19
|
+
project (has .sniper/config.yaml with completed phases) or a
|
|
20
|
+
standalone project (codebase analysis only).
|
|
21
|
+
|
|
22
|
+
- name: doc-writer
|
|
23
|
+
compose:
|
|
24
|
+
process: doc-writer
|
|
25
|
+
technical: from-config
|
|
26
|
+
cognitive: mentor-explainer
|
|
27
|
+
domain: from-config
|
|
28
|
+
tasks:
|
|
29
|
+
- id: write-readme
|
|
30
|
+
name: "Generate README.md"
|
|
31
|
+
output: "README.md"
|
|
32
|
+
template: ".sniper/templates/doc-readme.md"
|
|
33
|
+
blocked_by: [analyze-project]
|
|
34
|
+
description: >
|
|
35
|
+
Write the project README from artifacts and codebase analysis.
|
|
36
|
+
Include: overview, quick start, features, tech stack, project
|
|
37
|
+
structure, contributing link, license. Use the doc index to
|
|
38
|
+
determine what sources to read.
|
|
39
|
+
|
|
40
|
+
- id: write-guides
|
|
41
|
+
name: "Generate Documentation Guides"
|
|
42
|
+
output: "docs/"
|
|
43
|
+
template: ".sniper/templates/doc-guide.md"
|
|
44
|
+
blocked_by: [analyze-project]
|
|
45
|
+
description: >
|
|
46
|
+
Generate the documentation files requested by the user (setup,
|
|
47
|
+
architecture, API, deployment, etc.) based on the doc index.
|
|
48
|
+
Each guide follows the doc-guide template. Use the doc index
|
|
49
|
+
to determine which guides to generate and what sources to read.
|
|
50
|
+
|
|
51
|
+
- name: doc-reviewer
|
|
52
|
+
compose:
|
|
53
|
+
process: doc-reviewer
|
|
54
|
+
technical: null
|
|
55
|
+
cognitive: devils-advocate
|
|
56
|
+
domain: null
|
|
57
|
+
tasks:
|
|
58
|
+
- id: review-docs
|
|
59
|
+
name: "Review & Validate Documentation"
|
|
60
|
+
output: "docs/.sniper-doc-review.md"
|
|
61
|
+
blocked_by: [write-readme, write-guides]
|
|
62
|
+
description: >
|
|
63
|
+
Review all generated docs for accuracy, completeness, and
|
|
64
|
+
consistency. Verify code examples compile, links resolve,
|
|
65
|
+
and setup instructions actually work. Produce a review report
|
|
66
|
+
with PASS/WARN/FAIL for each file.
|
|
67
|
+
|
|
68
|
+
coordination:
|
|
69
|
+
- from: doc-analyst
|
|
70
|
+
to: doc-writer
|
|
71
|
+
trigger: analyze-project.complete
|
|
72
|
+
message: "Doc index ready at docs/.sniper-doc-index.json — read it to see what to generate"
|
|
73
|
+
|
|
74
|
+
review_gate:
|
|
75
|
+
checklist: ".sniper/checklists/doc-review.md"
|
|
76
|
+
mode: flexible
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
team_name: sniper-plan
|
|
2
|
+
phase: plan
|
|
3
|
+
model_override: opus
|
|
4
|
+
|
|
5
|
+
teammates:
|
|
6
|
+
- name: product-manager
|
|
7
|
+
compose:
|
|
8
|
+
process: product-manager
|
|
9
|
+
technical: api-design
|
|
10
|
+
cognitive: systems-thinker
|
|
11
|
+
domain: null
|
|
12
|
+
tasks:
|
|
13
|
+
- id: prd
|
|
14
|
+
name: "Product Requirements Document"
|
|
15
|
+
output: "docs/prd.md"
|
|
16
|
+
template: ".sniper/templates/prd.md"
|
|
17
|
+
reads: ["docs/brief.md", "docs/personas.md", "docs/risks.md"]
|
|
18
|
+
description: >
|
|
19
|
+
Write a comprehensive PRD covering: problem statement, user stories,
|
|
20
|
+
feature requirements (P0/P1/P2), success metrics, constraints,
|
|
21
|
+
and out-of-scope items. This is the single source of truth for what to build.
|
|
22
|
+
|
|
23
|
+
- name: architect
|
|
24
|
+
compose:
|
|
25
|
+
process: architect
|
|
26
|
+
technical: backend
|
|
27
|
+
cognitive: security-first
|
|
28
|
+
domain: null
|
|
29
|
+
tasks:
|
|
30
|
+
- id: architecture
|
|
31
|
+
name: "System Architecture Document"
|
|
32
|
+
output: "docs/architecture.md"
|
|
33
|
+
template: ".sniper/templates/architecture.md"
|
|
34
|
+
reads: ["docs/prd.md", "docs/brief.md", "docs/risks.md"]
|
|
35
|
+
blocked_by: [prd]
|
|
36
|
+
plan_approval: true
|
|
37
|
+
description: >
|
|
38
|
+
Design the complete system architecture. Include: component diagram,
|
|
39
|
+
data models, API contracts, infrastructure topology, technology choices
|
|
40
|
+
with rationale, and non-functional requirements.
|
|
41
|
+
|
|
42
|
+
- name: ux-designer
|
|
43
|
+
compose:
|
|
44
|
+
process: ux-designer
|
|
45
|
+
technical: frontend
|
|
46
|
+
cognitive: user-empathetic
|
|
47
|
+
domain: null
|
|
48
|
+
tasks:
|
|
49
|
+
- id: ux-spec
|
|
50
|
+
name: "UX Specification"
|
|
51
|
+
output: "docs/ux-spec.md"
|
|
52
|
+
template: ".sniper/templates/ux-spec.md"
|
|
53
|
+
reads: ["docs/prd.md", "docs/personas.md"]
|
|
54
|
+
blocked_by: [prd]
|
|
55
|
+
description: >
|
|
56
|
+
Define the UX: information architecture, screen inventory,
|
|
57
|
+
key user flows (with decision trees), component hierarchy,
|
|
58
|
+
interaction patterns, and responsive breakpoints.
|
|
59
|
+
|
|
60
|
+
- name: security-analyst
|
|
61
|
+
compose:
|
|
62
|
+
process: architect
|
|
63
|
+
technical: security
|
|
64
|
+
cognitive: security-first
|
|
65
|
+
domain: null
|
|
66
|
+
tasks:
|
|
67
|
+
- id: security
|
|
68
|
+
name: "Security & Compliance Requirements"
|
|
69
|
+
output: "docs/security.md"
|
|
70
|
+
template: ".sniper/templates/security.md"
|
|
71
|
+
reads: ["docs/prd.md", "docs/risks.md"]
|
|
72
|
+
blocked_by: [prd]
|
|
73
|
+
description: >
|
|
74
|
+
Define security architecture: auth model, data encryption strategy,
|
|
75
|
+
compliance requirements (with specific regulations), threat model,
|
|
76
|
+
and security testing requirements.
|
|
77
|
+
|
|
78
|
+
coordination:
|
|
79
|
+
- between: [architect, security-analyst]
|
|
80
|
+
topic: "Align security architecture with system architecture"
|
|
81
|
+
- between: [architect, ux-designer]
|
|
82
|
+
topic: "Align frontend component boundaries with backend API contracts"
|
|
83
|
+
|
|
84
|
+
review_gate:
|
|
85
|
+
checklist: ".sniper/checklists/plan-review.md"
|
|
86
|
+
mode: strict
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
team_name: null
|
|
2
|
+
phase: solve
|
|
3
|
+
|
|
4
|
+
agent:
|
|
5
|
+
compose:
|
|
6
|
+
process: scrum-master
|
|
7
|
+
technical: null
|
|
8
|
+
cognitive: systems-thinker
|
|
9
|
+
domain: null
|
|
10
|
+
reads:
|
|
11
|
+
- "docs/prd.md"
|
|
12
|
+
- "docs/architecture.md"
|
|
13
|
+
- "docs/ux-spec.md"
|
|
14
|
+
- "docs/security.md"
|
|
15
|
+
|
|
16
|
+
tasks:
|
|
17
|
+
- id: epic-sharding
|
|
18
|
+
name: "Epic Sharding"
|
|
19
|
+
output: "docs/epics/"
|
|
20
|
+
template: ".sniper/templates/epic.md"
|
|
21
|
+
description: >
|
|
22
|
+
Break the PRD into 6-12 epics. Each epic file must include:
|
|
23
|
+
- Scope and clear boundaries (what's in, what's out)
|
|
24
|
+
- Relevant sections from architecture doc (EMBEDDED, not just referenced)
|
|
25
|
+
- Dependencies on other epics
|
|
26
|
+
- Acceptance criteria for the epic as a whole
|
|
27
|
+
- Estimated total story points
|
|
28
|
+
|
|
29
|
+
- id: story-creation
|
|
30
|
+
name: "Story Creation"
|
|
31
|
+
output: "docs/stories/"
|
|
32
|
+
template: ".sniper/templates/story.md"
|
|
33
|
+
blocked_by: [epic-sharding]
|
|
34
|
+
description: >
|
|
35
|
+
For each epic, create 3-8 stories. Each story file must include:
|
|
36
|
+
- Full context from PRD + Architecture (EMBEDDED in the story file)
|
|
37
|
+
- Acceptance criteria as testable assertions
|
|
38
|
+
- Test requirements (unit, integration, e2e as applicable)
|
|
39
|
+
- File ownership (which directories this story's implementation touches)
|
|
40
|
+
- Dependencies on other stories
|
|
41
|
+
- Complexity estimate (S/M/L/XL)
|
|
42
|
+
|
|
43
|
+
CRITICAL: Stories must be self-contained. A teammate reading ONLY the story
|
|
44
|
+
file must have enough context to implement it without reading any other docs.
|
|
45
|
+
|
|
46
|
+
review_gate:
|
|
47
|
+
checklist: ".sniper/checklists/story-review.md"
|
|
48
|
+
mode: flexible
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
team_name: "sniper-sprint-{number}"
|
|
2
|
+
phase: sprint
|
|
3
|
+
|
|
4
|
+
available_teammates:
|
|
5
|
+
- name: backend-dev
|
|
6
|
+
compose:
|
|
7
|
+
process: developer
|
|
8
|
+
technical: backend
|
|
9
|
+
cognitive: systems-thinker
|
|
10
|
+
domain: null
|
|
11
|
+
owns_from_config: backend
|
|
12
|
+
model: sonnet
|
|
13
|
+
|
|
14
|
+
- name: frontend-dev
|
|
15
|
+
compose:
|
|
16
|
+
process: developer
|
|
17
|
+
technical: frontend
|
|
18
|
+
cognitive: user-empathetic
|
|
19
|
+
domain: null
|
|
20
|
+
owns_from_config: frontend
|
|
21
|
+
model: sonnet
|
|
22
|
+
|
|
23
|
+
- name: infra-dev
|
|
24
|
+
compose:
|
|
25
|
+
process: developer
|
|
26
|
+
technical: infrastructure
|
|
27
|
+
cognitive: systems-thinker
|
|
28
|
+
domain: null
|
|
29
|
+
owns_from_config: infrastructure
|
|
30
|
+
model: sonnet
|
|
31
|
+
|
|
32
|
+
- name: ai-dev
|
|
33
|
+
compose:
|
|
34
|
+
process: developer
|
|
35
|
+
technical: ai-ml
|
|
36
|
+
cognitive: performance-focused
|
|
37
|
+
domain: null
|
|
38
|
+
owns_from_config: ai
|
|
39
|
+
model: opus
|
|
40
|
+
|
|
41
|
+
- name: qa-engineer
|
|
42
|
+
compose:
|
|
43
|
+
process: qa-engineer
|
|
44
|
+
technical: backend
|
|
45
|
+
cognitive: devils-advocate
|
|
46
|
+
domain: null
|
|
47
|
+
owns_from_config: tests
|
|
48
|
+
model: sonnet
|
|
49
|
+
|
|
50
|
+
sprint_rules:
|
|
51
|
+
- "Each teammate reads their assigned story file(s) COMPLETELY before writing any code"
|
|
52
|
+
- "Backend and frontend must agree on API contracts via inter-agent messaging BEFORE implementing"
|
|
53
|
+
- "All new code must include tests — no story is complete without passing tests"
|
|
54
|
+
- "QA engineer is blocked until implementation stories are complete"
|
|
55
|
+
- "Every teammate messages the team lead when their task is complete"
|
|
56
|
+
- "If any teammate is blocked for > 10 minutes, message the lead immediately"
|
|
57
|
+
|
|
58
|
+
coordination:
|
|
59
|
+
- between: [backend-dev, frontend-dev]
|
|
60
|
+
topic: "API contracts — agree on endpoints, payloads, and auth before coding"
|
|
61
|
+
- between: [backend-dev, ai-dev]
|
|
62
|
+
topic: "AI pipeline integration points — data flow, WebSocket events, API boundaries"
|
|
63
|
+
- between: [backend-dev, qa-engineer]
|
|
64
|
+
topic: "Share testable endpoints as they're completed"
|
|
65
|
+
|
|
66
|
+
review_gate:
|
|
67
|
+
checklist: ".sniper/checklists/sprint-review.md"
|
|
68
|
+
mode: strict
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# System Architecture: {project_name}
|
|
2
|
+
|
|
3
|
+
> **Status:** Draft
|
|
4
|
+
> **Author:** Planning Team — Architect
|
|
5
|
+
> **Date:** {date}
|
|
6
|
+
> **Source:** `docs/prd.md`, `docs/brief.md`
|
|
7
|
+
|
|
8
|
+
## 1. Architecture Overview
|
|
9
|
+
<!-- High-level system description. Include an ASCII or Mermaid component diagram. -->
|
|
10
|
+
|
|
11
|
+
## 2. Technology Choices
|
|
12
|
+
| Component | Choice | Why | Alternatives Considered |
|
|
13
|
+
|-----------|--------|-----|------------------------|
|
|
14
|
+
| Language | | | |
|
|
15
|
+
| Frontend | | | |
|
|
16
|
+
| Backend | | | |
|
|
17
|
+
| Database | | | |
|
|
18
|
+
| Cache | | | |
|
|
19
|
+
| Queue | | | |
|
|
20
|
+
| Infrastructure | | | |
|
|
21
|
+
|
|
22
|
+
## 3. Component Architecture
|
|
23
|
+
<!-- Describe each major component, its responsibility, and its interfaces -->
|
|
24
|
+
|
|
25
|
+
### 3.1 {Component Name}
|
|
26
|
+
- **Responsibility:**
|
|
27
|
+
- **Interfaces:**
|
|
28
|
+
- **Dependencies:**
|
|
29
|
+
|
|
30
|
+
## 4. Data Models
|
|
31
|
+
<!-- Entity-relationship descriptions with field types, constraints, indexes -->
|
|
32
|
+
|
|
33
|
+
### 4.1 {Entity Name}
|
|
34
|
+
| Field | Type | Constraints | Index | Notes |
|
|
35
|
+
|-------|------|------------|-------|-------|
|
|
36
|
+
| | | | | |
|
|
37
|
+
|
|
38
|
+
## 5. API Contracts
|
|
39
|
+
<!-- RESTful endpoints with methods, paths, request/response payloads -->
|
|
40
|
+
|
|
41
|
+
### 5.1 {Resource}
|
|
42
|
+
```
|
|
43
|
+
METHOD /api/v1/{resource}
|
|
44
|
+
Request: { }
|
|
45
|
+
Response: { }
|
|
46
|
+
Status Codes: 200, 400, 401, 404, 500
|
|
47
|
+
Auth: Required
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## 6. Infrastructure Topology
|
|
51
|
+
<!-- Compute, storage, networking, scaling strategy -->
|
|
52
|
+
|
|
53
|
+
## 7. Cross-Cutting Concerns
|
|
54
|
+
|
|
55
|
+
### 7.1 Authentication & Authorization
|
|
56
|
+
### 7.2 Logging & Monitoring
|
|
57
|
+
### 7.3 Error Handling
|
|
58
|
+
### 7.4 Configuration Management
|
|
59
|
+
|
|
60
|
+
## 8. Non-Functional Requirements
|
|
61
|
+
| Requirement | Target | Strategy |
|
|
62
|
+
|-------------|--------|----------|
|
|
63
|
+
| Response time (p95) | | |
|
|
64
|
+
| Availability | | |
|
|
65
|
+
| Throughput | | |
|
|
66
|
+
| Data retention | | |
|
|
67
|
+
|
|
68
|
+
## 9. Migration & Deployment Strategy
|
|
69
|
+
<!-- How the system gets deployed. CI/CD, blue-green, rollback strategy. -->
|
|
70
|
+
|
|
71
|
+
## 10. Security Architecture
|
|
72
|
+
<!-- Reference docs/security.md for detailed security requirements -->
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Project Brief: {project_name}
|
|
2
|
+
|
|
3
|
+
> **Status:** Draft
|
|
4
|
+
> **Author:** Discovery Team — Analyst
|
|
5
|
+
> **Date:** {date}
|
|
6
|
+
|
|
7
|
+
## Executive Summary
|
|
8
|
+
<!-- 2-3 sentence overview of the project and its value proposition -->
|
|
9
|
+
|
|
10
|
+
## Problem Statement
|
|
11
|
+
<!-- What problem does this solve? Who has this problem? How is it currently solved? -->
|
|
12
|
+
|
|
13
|
+
## Market Landscape
|
|
14
|
+
|
|
15
|
+
### Direct Competitors
|
|
16
|
+
| Competitor | Key Features | Pricing | Market Position | Weaknesses |
|
|
17
|
+
|-----------|-------------|---------|-----------------|------------|
|
|
18
|
+
| | | | | |
|
|
19
|
+
|
|
20
|
+
### Indirect Competitors / Alternatives
|
|
21
|
+
<!-- How are users solving this problem today without a dedicated tool? -->
|
|
22
|
+
|
|
23
|
+
## Target Market
|
|
24
|
+
- **Primary segment:** <!-- Who is the ideal customer? -->
|
|
25
|
+
- **Market size:** <!-- TAM/SAM/SOM estimates if available -->
|
|
26
|
+
- **Growth trends:** <!-- Is this market growing? Why? -->
|
|
27
|
+
|
|
28
|
+
## Unique Value Proposition
|
|
29
|
+
<!-- What makes this product different from everything else? Be specific. -->
|
|
30
|
+
|
|
31
|
+
## Key Assumptions
|
|
32
|
+
<!-- List assumptions that need validation. These are things you believe but haven't proven. -->
|
|
33
|
+
1.
|
|
34
|
+
2.
|
|
35
|
+
3.
|
|
36
|
+
|
|
37
|
+
## Technical Constraints
|
|
38
|
+
<!-- Known technical limitations, required integrations, regulatory requirements -->
|
|
39
|
+
|
|
40
|
+
## Initial Scope Recommendation
|
|
41
|
+
<!-- What should v1 include? What should it NOT include? -->
|
|
42
|
+
|
|
43
|
+
### In Scope (v1)
|
|
44
|
+
-
|
|
45
|
+
|
|
46
|
+
### Out of Scope (v1)
|
|
47
|
+
-
|
|
48
|
+
|
|
49
|
+
## Open Questions
|
|
50
|
+
<!-- Questions that need answers before planning can begin -->
|
|
51
|
+
1.
|
|
52
|
+
2.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# API Reference
|
|
2
|
+
|
|
3
|
+
> {one_line_description}
|
|
4
|
+
|
|
5
|
+
<!-- sniper:managed:start -->
|
|
6
|
+
|
|
7
|
+
## Base URL
|
|
8
|
+
```
|
|
9
|
+
{base_url}
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Authentication
|
|
13
|
+
<!-- Auth method: API key, JWT, OAuth, etc. -->
|
|
14
|
+
|
|
15
|
+
## Endpoints
|
|
16
|
+
|
|
17
|
+
### {Resource Group 1}
|
|
18
|
+
|
|
19
|
+
#### `{METHOD} {path}`
|
|
20
|
+
{description}
|
|
21
|
+
|
|
22
|
+
**Request**
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
**Response** `{status_code}`
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
**Error Codes**
|
|
35
|
+
| Code | Description |
|
|
36
|
+
|------|-------------|
|
|
37
|
+
| | |
|
|
38
|
+
|
|
39
|
+
<!-- Repeat for each endpoint -->
|
|
40
|
+
|
|
41
|
+
## Common Error Responses
|
|
42
|
+
| Status | Code | Description |
|
|
43
|
+
|--------|------|-------------|
|
|
44
|
+
| 400 | BAD_REQUEST | Invalid request parameters |
|
|
45
|
+
| 401 | UNAUTHORIZED | Missing or invalid authentication |
|
|
46
|
+
| 403 | FORBIDDEN | Insufficient permissions |
|
|
47
|
+
| 404 | NOT_FOUND | Resource does not exist |
|
|
48
|
+
| 500 | INTERNAL_ERROR | Unexpected server error |
|
|
49
|
+
|
|
50
|
+
## Rate Limiting
|
|
51
|
+
<!-- Rate limit details if applicable -->
|
|
52
|
+
|
|
53
|
+
<!-- sniper:managed:end -->
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# {guide_title}
|
|
2
|
+
|
|
3
|
+
> {one_line_summary}
|
|
4
|
+
|
|
5
|
+
<!-- sniper:managed:start -->
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
<!-- What this guide covers and who it's for -->
|
|
9
|
+
|
|
10
|
+
## Prerequisites
|
|
11
|
+
<!-- What the reader needs before starting -->
|
|
12
|
+
-
|
|
13
|
+
|
|
14
|
+
## Steps
|
|
15
|
+
|
|
16
|
+
### 1. {first_step}
|
|
17
|
+
<!-- Detailed instructions with code examples -->
|
|
18
|
+
|
|
19
|
+
### 2. {second_step}
|
|
20
|
+
<!-- Continue as needed -->
|
|
21
|
+
|
|
22
|
+
## Examples
|
|
23
|
+
<!-- Working examples that demonstrate the key concepts -->
|
|
24
|
+
|
|
25
|
+
## Troubleshooting
|
|
26
|
+
<!-- Common issues and their solutions -->
|
|
27
|
+
| Problem | Solution |
|
|
28
|
+
|---------|----------|
|
|
29
|
+
| | |
|
|
30
|
+
|
|
31
|
+
## Related Documentation
|
|
32
|
+
<!-- Links to other relevant docs -->
|
|
33
|
+
-
|
|
34
|
+
|
|
35
|
+
<!-- sniper:managed:end -->
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# {project_name}
|
|
2
|
+
|
|
3
|
+
> {one_line_description}
|
|
4
|
+
|
|
5
|
+
<!-- sniper:managed:start -->
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
<!-- 2-3 sentences explaining what the project does and who it's for -->
|
|
9
|
+
|
|
10
|
+
## Features
|
|
11
|
+
<!-- Bullet list of key features. Source from PRD P0/P1 or infer from codebase -->
|
|
12
|
+
-
|
|
13
|
+
|
|
14
|
+
## Quick Start
|
|
15
|
+
|
|
16
|
+
### Prerequisites
|
|
17
|
+
<!-- List runtime requirements: Node.js version, database, etc. -->
|
|
18
|
+
-
|
|
19
|
+
|
|
20
|
+
### Installation
|
|
21
|
+
```bash
|
|
22
|
+
# Clone, install, and run commands — must actually work
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Usage
|
|
26
|
+
```bash
|
|
27
|
+
# Primary usage example
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Tech Stack
|
|
31
|
+
| Layer | Technology |
|
|
32
|
+
|-------|-----------|
|
|
33
|
+
| | |
|
|
34
|
+
|
|
35
|
+
## Project Structure
|
|
36
|
+
```
|
|
37
|
+
project-root/
|
|
38
|
+
├── src/
|
|
39
|
+
│ └── ...
|
|
40
|
+
└── ...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
<!-- sniper:managed:end -->
|
|
44
|
+
|
|
45
|
+
## Contributing
|
|
46
|
+
<!-- Link to CONTRIBUTING.md if it exists, or brief instructions -->
|
|
47
|
+
|
|
48
|
+
## License
|
|
49
|
+
<!-- License type and link -->
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Epic {number}: {title}
|
|
2
|
+
|
|
3
|
+
> **Status:** Draft
|
|
4
|
+
> **Priority:** P{0|1|2}
|
|
5
|
+
> **Estimated Points:** {total}
|
|
6
|
+
> **Dependencies:** {epic dependencies or "None"}
|
|
7
|
+
|
|
8
|
+
## Scope
|
|
9
|
+
<!-- What this epic covers and what it explicitly does NOT cover -->
|
|
10
|
+
|
|
11
|
+
### In Scope
|
|
12
|
+
-
|
|
13
|
+
|
|
14
|
+
### Out of Scope
|
|
15
|
+
-
|
|
16
|
+
|
|
17
|
+
## Architecture Context
|
|
18
|
+
<!-- EMBED relevant sections from docs/architecture.md — don't just reference -->
|
|
19
|
+
|
|
20
|
+
## Stories
|
|
21
|
+
| # | Story | Complexity | Dependencies | Owner |
|
|
22
|
+
|---|-------|-----------|-------------|-------|
|
|
23
|
+
| {epic}.1 | | S/M/L/XL | | backend/frontend/infra |
|
|
24
|
+
| {epic}.2 | | | | |
|
|
25
|
+
|
|
26
|
+
## Acceptance Criteria
|
|
27
|
+
<!-- Epic-level acceptance criteria — what must be true when ALL stories are done -->
|
|
28
|
+
1.
|
|
29
|
+
2.
|
|
30
|
+
3.
|
|
31
|
+
|
|
32
|
+
## Technical Notes
|
|
33
|
+
<!-- Any technical considerations specific to this epic -->
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# User Personas & Journey Maps: {project_name}
|
|
2
|
+
|
|
3
|
+
> **Status:** Draft
|
|
4
|
+
> **Author:** Discovery Team — User Researcher
|
|
5
|
+
> **Date:** {date}
|
|
6
|
+
|
|
7
|
+
## Persona Overview
|
|
8
|
+
<!-- Brief summary of who uses this product and why -->
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Persona 1: {persona_name}
|
|
13
|
+
|
|
14
|
+
### Demographics & Context
|
|
15
|
+
- **Role:** <!-- Job title or role -->
|
|
16
|
+
- **Experience Level:** <!-- Junior / Mid / Senior / Executive -->
|
|
17
|
+
- **Tech Savviness:** <!-- Low / Medium / High -->
|
|
18
|
+
- **Usage Frequency:** <!-- Daily / Weekly / Monthly -->
|
|
19
|
+
|
|
20
|
+
### Goals
|
|
21
|
+
1.
|
|
22
|
+
2.
|
|
23
|
+
3.
|
|
24
|
+
|
|
25
|
+
### Pain Points
|
|
26
|
+
1.
|
|
27
|
+
2.
|
|
28
|
+
3.
|
|
29
|
+
|
|
30
|
+
### Current Workflow
|
|
31
|
+
<!-- How does this persona solve the problem today without this product? -->
|
|
32
|
+
|
|
33
|
+
### User Journey Map
|
|
34
|
+
|
|
35
|
+
| Stage | Action | Touchpoint | Emotion | Opportunity |
|
|
36
|
+
|-------|--------|------------|---------|-------------|
|
|
37
|
+
| Awareness | | | | |
|
|
38
|
+
| Onboarding | | | | |
|
|
39
|
+
| First Use | | | | |
|
|
40
|
+
| Regular Use | | | | |
|
|
41
|
+
| Advanced Use | | | | |
|
|
42
|
+
|
|
43
|
+
### Key Scenarios
|
|
44
|
+
<!-- 2-3 specific scenarios where this persona interacts with the product -->
|
|
45
|
+
|
|
46
|
+
#### Scenario 1: {scenario_name}
|
|
47
|
+
- **Context:** <!-- When and where does this happen? -->
|
|
48
|
+
- **Trigger:** <!-- What initiates this scenario? -->
|
|
49
|
+
- **Steps:** <!-- What does the user do? -->
|
|
50
|
+
- **Success Criteria:** <!-- How does the user know they succeeded? -->
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Persona 2: {persona_name}
|
|
55
|
+
|
|
56
|
+
### Demographics & Context
|
|
57
|
+
- **Role:**
|
|
58
|
+
- **Experience Level:**
|
|
59
|
+
- **Tech Savviness:**
|
|
60
|
+
- **Usage Frequency:**
|
|
61
|
+
|
|
62
|
+
### Goals
|
|
63
|
+
1.
|
|
64
|
+
2.
|
|
65
|
+
3.
|
|
66
|
+
|
|
67
|
+
### Pain Points
|
|
68
|
+
1.
|
|
69
|
+
2.
|
|
70
|
+
3.
|
|
71
|
+
|
|
72
|
+
### Current Workflow
|
|
73
|
+
|
|
74
|
+
### User Journey Map
|
|
75
|
+
|
|
76
|
+
| Stage | Action | Touchpoint | Emotion | Opportunity |
|
|
77
|
+
|-------|--------|------------|---------|-------------|
|
|
78
|
+
| Awareness | | | | |
|
|
79
|
+
| Onboarding | | | | |
|
|
80
|
+
| First Use | | | | |
|
|
81
|
+
| Regular Use | | | | |
|
|
82
|
+
| Advanced Use | | | | |
|
|
83
|
+
|
|
84
|
+
### Key Scenarios
|
|
85
|
+
|
|
86
|
+
#### Scenario 1: {scenario_name}
|
|
87
|
+
- **Context:**
|
|
88
|
+
- **Trigger:**
|
|
89
|
+
- **Steps:**
|
|
90
|
+
- **Success Criteria:**
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Cross-Persona Analysis
|
|
95
|
+
|
|
96
|
+
### Shared Needs
|
|
97
|
+
<!-- What do all personas have in common? -->
|
|
98
|
+
|
|
99
|
+
### Conflicting Needs
|
|
100
|
+
<!-- Where do personas' needs diverge? How should the product handle this? -->
|
|
101
|
+
|
|
102
|
+
### Prioritization
|
|
103
|
+
| Persona | Priority | Justification |
|
|
104
|
+
|---------|----------|---------------|
|
|
105
|
+
| | P0 | |
|
|
106
|
+
| | P1 | |
|
|
107
|
+
|
|
108
|
+
## Friction Points Summary
|
|
109
|
+
<!-- Top friction points across all personas, ranked by severity -->
|
|
110
|
+
1.
|
|
111
|
+
2.
|
|
112
|
+
3.
|
|
113
|
+
|
|
114
|
+
## Moments of Delight
|
|
115
|
+
<!-- Opportunities to exceed user expectations -->
|
|
116
|
+
1.
|
|
117
|
+
2.
|
|
118
|
+
3.
|