teamspec 4.2.0 → 4.3.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/lib/cli.js +135 -4
- package/lib/linter.js +192 -3
- package/package.json +1 -1
- package/teamspec-core/agents/AGENT_BA.md +15 -0
- package/teamspec-core/agents/AGENT_BOOTSTRAP.md +115 -2
- package/teamspec-core/agents/AGENT_DES.md +16 -0
- package/teamspec-core/agents/AGENT_DEV.md +24 -2
- package/teamspec-core/agents/AGENT_FA.md +25 -2
- package/teamspec-core/agents/AGENT_FEEDBACK.md +24 -1
- package/teamspec-core/agents/AGENT_FIX.md +16 -0
- package/teamspec-core/agents/AGENT_PO.md +17 -0
- package/teamspec-core/agents/AGENT_QA.md +16 -0
- package/teamspec-core/agents/AGENT_SA.md +16 -0
- package/teamspec-core/agents/AGENT_SM.md +17 -0
- package/teamspec-core/agents/README.md +32 -2
- package/teamspec-core/templates/active-sprint-template.md +30 -1
- package/teamspec-core/templates/bai-template.md +57 -1
- package/teamspec-core/templates/bug-report-template.md +59 -0
- package/teamspec-core/templates/business-analysis-template.md +57 -0
- package/teamspec-core/templates/decision-log-template.md +58 -0
- package/teamspec-core/templates/dev-plan-template.md +51 -0
- package/teamspec-core/templates/epic-template.md +75 -6
- package/teamspec-core/templates/feature-increment-template.md +111 -10
- package/teamspec-core/templates/feature-template.md +89 -15
- package/teamspec-core/templates/functional-spec-template.md +43 -1
- package/teamspec-core/templates/refinement-notes-template.md +38 -1
- package/teamspec-core/templates/ri-template.md +50 -0
- package/teamspec-core/templates/rt-template.md +54 -0
- package/teamspec-core/templates/sd-template.md +60 -1
- package/teamspec-core/templates/sdi-template.md +62 -1
- package/teamspec-core/templates/sprint-goal-template.md +41 -1
- package/teamspec-core/templates/sprint-template.md +53 -0
- package/teamspec-core/templates/sprints-index-template.md +30 -1
- package/teamspec-core/templates/story-template.md +71 -4
- package/teamspec-core/templates/storymap-template.md +33 -0
- package/teamspec-core/templates/ta-template.md +67 -0
- package/teamspec-core/templates/tai-template.md +62 -1
- package/teamspec-core/templates/tc-template.md +56 -1
- package/teamspec-core/templates/uat-pack-template.md +52 -1
|
@@ -1,4 +1,55 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
# === LLM Retrieval Metadata ===
|
|
3
|
+
artifact_kind: sd
|
|
4
|
+
spec_version: "4.0"
|
|
5
|
+
template_version: "4.0.1"
|
|
6
|
+
|
|
7
|
+
# === Ownership ===
|
|
8
|
+
role_owner: SA
|
|
9
|
+
artifact_type: Product Canon
|
|
10
|
+
canonicity: canon
|
|
11
|
+
lifecycle: permanent
|
|
12
|
+
|
|
13
|
+
# === Naming ===
|
|
14
|
+
id_pattern: "sd-{PRX}-{NNN}"
|
|
15
|
+
filename_pattern: "sd-{PRX}-{NNN}-{description}.md"
|
|
16
|
+
|
|
17
|
+
# === Required Relationships ===
|
|
18
|
+
links_required:
|
|
19
|
+
- type: product
|
|
20
|
+
pattern: "product.yml"
|
|
21
|
+
optional: false
|
|
22
|
+
- type: feature
|
|
23
|
+
pattern: "f-{PRX}-{NNN}"
|
|
24
|
+
optional: true
|
|
25
|
+
|
|
26
|
+
# === Search Optimization ===
|
|
27
|
+
keywords:
|
|
28
|
+
- solution design
|
|
29
|
+
- integration design
|
|
30
|
+
- system design
|
|
31
|
+
- component design
|
|
32
|
+
aliases:
|
|
33
|
+
- design document
|
|
34
|
+
- technical solution
|
|
35
|
+
anti_keywords:
|
|
36
|
+
- architecture decision
|
|
37
|
+
- business requirements
|
|
38
|
+
- story
|
|
39
|
+
|
|
40
|
+
# === Generation Contract ===
|
|
41
|
+
completion_rules:
|
|
42
|
+
placeholders: "Fill {braces} only"
|
|
43
|
+
required_sections:
|
|
44
|
+
- Overview
|
|
45
|
+
- Business Context
|
|
46
|
+
- Solution
|
|
47
|
+
optional_sections:
|
|
48
|
+
- Alternatives
|
|
49
|
+
- Risks
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
# Solution Design: `sd-{PRX}-{NNN}-{description}`
|
|
2
53
|
|
|
3
54
|
> **ID:** sd-PRX-XXX
|
|
4
55
|
> **Product:** `<product-id>` (PRX)
|
|
@@ -28,12 +79,20 @@
|
|
|
28
79
|
|
|
29
80
|
## 1. Overview
|
|
30
81
|
|
|
82
|
+
> **Contract:** What this solution accomplishes at a glance.
|
|
83
|
+
> **Required precision:** One paragraph summary.
|
|
84
|
+
> **Not this:** Full technical details (those go in Solution Architecture).
|
|
85
|
+
|
|
31
86
|
_Brief description of the solution design and what it accomplishes._
|
|
32
87
|
|
|
33
88
|
---
|
|
34
89
|
|
|
35
90
|
## 2. Business Context
|
|
36
91
|
|
|
92
|
+
> **Contract:** Business driver for this design.
|
|
93
|
+
> **Required precision:** Link to Feature Canon and requirements.
|
|
94
|
+
> **Not this:** Technical rationale (that goes in Design Rationale).
|
|
95
|
+
|
|
37
96
|
> Reference to Feature Canon and business requirements that drove this design.
|
|
38
97
|
|
|
39
98
|
_What business need or requirement triggered this design?_
|
|
@@ -1,4 +1,53 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
# === LLM Retrieval Metadata ===
|
|
3
|
+
artifact_kind: sdi
|
|
4
|
+
spec_version: "4.0"
|
|
5
|
+
template_version: "4.0.1"
|
|
6
|
+
|
|
7
|
+
# === Ownership ===
|
|
8
|
+
role_owner: SA
|
|
9
|
+
artifact_type: Project Execution
|
|
10
|
+
canonicity: project-execution
|
|
11
|
+
lifecycle: project-bound
|
|
12
|
+
|
|
13
|
+
# === Naming ===
|
|
14
|
+
id_pattern: "sdi-{PRX}-{NNN}"
|
|
15
|
+
filename_pattern: "sdi-{PRX}-{NNN}-{description}.md"
|
|
16
|
+
|
|
17
|
+
# === Required Relationships ===
|
|
18
|
+
links_required:
|
|
19
|
+
- type: solution-design
|
|
20
|
+
pattern: "sd-{PRX}-{NNN}"
|
|
21
|
+
optional: false
|
|
22
|
+
- type: feature-increment
|
|
23
|
+
pattern: "fi-{PRX}-{NNN}"
|
|
24
|
+
optional: true
|
|
25
|
+
|
|
26
|
+
# === Search Optimization ===
|
|
27
|
+
keywords:
|
|
28
|
+
- solution design increment
|
|
29
|
+
- SDI
|
|
30
|
+
- design delta
|
|
31
|
+
- integration change
|
|
32
|
+
aliases:
|
|
33
|
+
- design change proposal
|
|
34
|
+
anti_keywords:
|
|
35
|
+
- architecture decision
|
|
36
|
+
- story
|
|
37
|
+
- feature behavior
|
|
38
|
+
|
|
39
|
+
# === Generation Contract ===
|
|
40
|
+
completion_rules:
|
|
41
|
+
placeholders: "Fill {braces} only"
|
|
42
|
+
required_sections:
|
|
43
|
+
- Overview
|
|
44
|
+
- AS-IS
|
|
45
|
+
- TO-BE
|
|
46
|
+
optional_sections:
|
|
47
|
+
- Risks
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
# Solution Design Increment: `sdi-{PRX}-{NNN}-{description}`
|
|
2
51
|
|
|
3
52
|
> **ID:** sdi-PRX-XXX
|
|
4
53
|
> **Product:** `<product-id>` (PRX)
|
|
@@ -30,12 +79,20 @@
|
|
|
30
79
|
|
|
31
80
|
## 1. Overview
|
|
32
81
|
|
|
82
|
+
> **Contract:** Summary of this design increment.
|
|
83
|
+
> **Required precision:** What changes and why for this project.
|
|
84
|
+
> **Not this:** Full SD document (that's the Product SD).
|
|
85
|
+
|
|
33
86
|
_Brief description of the solution design increment specific to this project._
|
|
34
87
|
|
|
35
88
|
---
|
|
36
89
|
|
|
37
90
|
## 2. AS-IS (Current Product SD)
|
|
38
91
|
|
|
92
|
+
> **Contract:** Current production design state.
|
|
93
|
+
> **Required precision:** Copy from Product SD, do not paraphrase.
|
|
94
|
+
> **Not this:** Proposed changes (those go in TO-BE).
|
|
95
|
+
|
|
39
96
|
> _Auto-populated from Product Solution Design. DO NOT EDIT unless correcting errors._
|
|
40
97
|
|
|
41
98
|
_Copy relevant sections from the Product SD._
|
|
@@ -44,6 +101,10 @@ _Copy relevant sections from the Product SD._
|
|
|
44
101
|
|
|
45
102
|
## 3. TO-BE (Project Solution Design)
|
|
46
103
|
|
|
104
|
+
> **Contract:** Proposed design after this increment.
|
|
105
|
+
> **Required precision:** Specific changes, not full restatement.
|
|
106
|
+
> **Not this:** Current state (that's AS-IS).
|
|
107
|
+
|
|
47
108
|
### 3.1 New/Changed Design Elements
|
|
48
109
|
|
|
49
110
|
_Describe what the project-specific solution design includes that product design doesn't._
|
|
@@ -1,6 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
artifact_kind: sprint-goal
|
|
3
|
+
spec_version: "4.0"
|
|
4
|
+
template_version: "4.0.1"
|
|
5
|
+
role_owner: SM
|
|
6
|
+
keywords:
|
|
7
|
+
- sprint goal
|
|
8
|
+
- sprint objective
|
|
9
|
+
- sprint commitment
|
|
10
|
+
- sprint planning output
|
|
11
|
+
- iteration goal
|
|
12
|
+
- sprint success criteria
|
|
13
|
+
- sprint focus
|
|
14
|
+
- sprint capacity
|
|
15
|
+
- committed stories
|
|
16
|
+
anti_keywords:
|
|
17
|
+
- product backlog
|
|
18
|
+
- feature canon
|
|
19
|
+
- epic planning
|
|
20
|
+
- release planning
|
|
21
|
+
- retrospective
|
|
22
|
+
links_required:
|
|
23
|
+
- type: story
|
|
24
|
+
pattern: "stories/S-*.md"
|
|
25
|
+
- type: sprint
|
|
26
|
+
pattern: "sprints/sprint-*/"
|
|
27
|
+
completion_rules:
|
|
28
|
+
goal_rule: "Sprint goal must be one clear, measurable objective"
|
|
29
|
+
success_criteria_rule: "Must have specific, measurable success criteria"
|
|
30
|
+
story_link_rule: "Committed stories must link to story files"
|
|
31
|
+
---
|
|
32
|
+
|
|
1
33
|
# Sprint {N} Goal
|
|
2
34
|
|
|
3
|
-
> **Template Version**:
|
|
35
|
+
> **Template Version**: 4.0.1
|
|
4
36
|
> **Last Updated**: 2026-01-07
|
|
5
37
|
> **Sprint Duration**: {YYYY-MM-DD} to {YYYY-MM-DD}
|
|
6
38
|
> **Status**: Planning | Active | Closed
|
|
@@ -15,6 +47,10 @@
|
|
|
15
47
|
|
|
16
48
|
## Sprint Goal
|
|
17
49
|
|
|
50
|
+
> **Contract:** One clear, measurable objective for the sprint.
|
|
51
|
+
> **Required precision:** Specific outcomes that can be verified.
|
|
52
|
+
> **Not this:** Feature lists, vague themes, or multiple goals.
|
|
53
|
+
|
|
18
54
|
> {One clear, measurable objective that the team commits to achieving this sprint}
|
|
19
55
|
|
|
20
56
|
**Success Criteria**:
|
|
@@ -38,6 +74,10 @@
|
|
|
38
74
|
|
|
39
75
|
## Committed Stories
|
|
40
76
|
|
|
77
|
+
> **Contract:** Stories committed for this sprint with links and status.
|
|
78
|
+
> **Required precision:** Each story must link to its dev plan and owner.
|
|
79
|
+
> **Not this:** Uncommitted backlog items or wishlist entries.
|
|
80
|
+
|
|
41
81
|
| Story ID | Title | Points | Dev Plan | Owner | Status |
|
|
42
82
|
|----------|-------|--------|----------|-------|--------|
|
|
43
83
|
| [S-XXX](../../stories/ready-for-development/S-XXX-*.md) | {Title} | {N} | [Plan](../../dev-plans/story-XXX-tasks.md) | @{dev} | Not Started |
|
|
@@ -1,3 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
# === LLM Retrieval Metadata ===
|
|
3
|
+
artifact_kind: sprint
|
|
4
|
+
spec_version: "4.0"
|
|
5
|
+
template_version: "4.0.1"
|
|
6
|
+
|
|
7
|
+
# === Ownership ===
|
|
8
|
+
role_owner: SM
|
|
9
|
+
artifact_type: Operational
|
|
10
|
+
canonicity: planning
|
|
11
|
+
lifecycle: sprint-bound
|
|
12
|
+
|
|
13
|
+
# === Naming ===
|
|
14
|
+
id_pattern: "sprint-{N}"
|
|
15
|
+
filename_pattern: "sprint-{N}/sprint-goal.md"
|
|
16
|
+
|
|
17
|
+
# === Required Relationships ===
|
|
18
|
+
links_required:
|
|
19
|
+
- type: project
|
|
20
|
+
pattern: "project.yml"
|
|
21
|
+
optional: false
|
|
22
|
+
|
|
23
|
+
# === Search Optimization ===
|
|
24
|
+
keywords:
|
|
25
|
+
- sprint
|
|
26
|
+
- iteration
|
|
27
|
+
- planning
|
|
28
|
+
- commitment
|
|
29
|
+
- capacity
|
|
30
|
+
aliases:
|
|
31
|
+
- iteration
|
|
32
|
+
- cycle
|
|
33
|
+
anti_keywords:
|
|
34
|
+
- feature
|
|
35
|
+
- story content
|
|
36
|
+
- requirements
|
|
37
|
+
|
|
38
|
+
# === Generation Contract ===
|
|
39
|
+
completion_rules:
|
|
40
|
+
placeholders: "Fill {braces} only"
|
|
41
|
+
required_sections:
|
|
42
|
+
- Sprint Goal
|
|
43
|
+
- Metadata
|
|
44
|
+
- Committed Stories
|
|
45
|
+
optional_sections:
|
|
46
|
+
- Risks
|
|
47
|
+
- Notes
|
|
48
|
+
---
|
|
49
|
+
|
|
1
50
|
# Sprint {N}
|
|
2
51
|
|
|
3
52
|
<!--
|
|
@@ -30,6 +79,10 @@
|
|
|
30
79
|
|
|
31
80
|
## Sprint Goal
|
|
32
81
|
|
|
82
|
+
> **Contract:** One clear, measurable objective with success criteria.
|
|
83
|
+
> **Required precision:** Specific, testable outcomes by sprint end.
|
|
84
|
+
> **Not this:** Vague aspirations or feature lists.
|
|
85
|
+
|
|
33
86
|
> {One-sentence sprint objective that describes what value will be delivered}
|
|
34
87
|
|
|
35
88
|
---
|
|
@@ -1,6 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
artifact_kind: sprints-index
|
|
3
|
+
spec_version: "4.0"
|
|
4
|
+
template_version: "4.0.1"
|
|
5
|
+
role_owner: SM
|
|
6
|
+
keywords:
|
|
7
|
+
- sprints index
|
|
8
|
+
- sprint history
|
|
9
|
+
- velocity trend
|
|
10
|
+
- sprint overview
|
|
11
|
+
- sprint list
|
|
12
|
+
- iteration history
|
|
13
|
+
- sprint archive
|
|
14
|
+
- velocity tracking
|
|
15
|
+
anti_keywords:
|
|
16
|
+
- active sprint details
|
|
17
|
+
- sprint planning
|
|
18
|
+
- backlog
|
|
19
|
+
- feature index
|
|
20
|
+
links_required:
|
|
21
|
+
- type: sprint-goal
|
|
22
|
+
pattern: "sprints/sprint-*/sprint-goal.md"
|
|
23
|
+
- type: active-sprint
|
|
24
|
+
pattern: "sprints/active-sprint.md"
|
|
25
|
+
completion_rules:
|
|
26
|
+
history_rule: "All closed sprints must be listed with velocity and status"
|
|
27
|
+
velocity_rule: "Average velocity must be calculated and updated"
|
|
28
|
+
---
|
|
29
|
+
|
|
1
30
|
# Sprints Index
|
|
2
31
|
|
|
3
|
-
> **Template Version**:
|
|
32
|
+
> **Template Version**: 4.0.1
|
|
4
33
|
> **Last Updated**: 2026-01-07
|
|
5
34
|
> **Note**: This index provides an overview of all sprints. See [active-sprint.md](active-sprint.md) for live status.
|
|
6
35
|
|
|
@@ -1,3 +1,65 @@
|
|
|
1
|
+
---
|
|
2
|
+
# === LLM Retrieval Metadata ===
|
|
3
|
+
artifact_kind: story
|
|
4
|
+
spec_version: "4.0"
|
|
5
|
+
template_version: "4.0.1"
|
|
6
|
+
|
|
7
|
+
# === Ownership ===
|
|
8
|
+
role_owner: FA
|
|
9
|
+
artifact_type: Project Execution
|
|
10
|
+
canonicality: project-execution
|
|
11
|
+
lifecycle: sprint-bound
|
|
12
|
+
|
|
13
|
+
# === Naming ===
|
|
14
|
+
id_pattern: "s-e{EEE}-{SSS}"
|
|
15
|
+
filename_pattern: "s-e{EEE}-{SSS}-{description}.md"
|
|
16
|
+
|
|
17
|
+
# === Required Relationships ===
|
|
18
|
+
links_required:
|
|
19
|
+
- type: epic
|
|
20
|
+
pattern: "epic-{PRX}-{NNN}"
|
|
21
|
+
optional: false
|
|
22
|
+
note: "Epic ID embedded in filename (eXXX)"
|
|
23
|
+
- type: feature-increment
|
|
24
|
+
pattern: "fi-{PRX}-{NNN}"
|
|
25
|
+
optional: true
|
|
26
|
+
note: "Recommended for behavior changes"
|
|
27
|
+
|
|
28
|
+
# === Search Optimization ===
|
|
29
|
+
keywords:
|
|
30
|
+
- user story
|
|
31
|
+
- delta
|
|
32
|
+
- change request
|
|
33
|
+
- acceptance criteria
|
|
34
|
+
- sprint work
|
|
35
|
+
- execution task
|
|
36
|
+
aliases:
|
|
37
|
+
- ticket
|
|
38
|
+
- work item
|
|
39
|
+
- task
|
|
40
|
+
- backlog item
|
|
41
|
+
anti_keywords:
|
|
42
|
+
- full behavior
|
|
43
|
+
- production truth
|
|
44
|
+
- canon
|
|
45
|
+
- feature specification
|
|
46
|
+
- requirements document
|
|
47
|
+
|
|
48
|
+
# === Generation Contract ===
|
|
49
|
+
completion_rules:
|
|
50
|
+
placeholders: "Fill {braces} only; leave {TBD} if unknown"
|
|
51
|
+
id_generation: "Story ID derived from epic (eXXX) + sequence (YYY)"
|
|
52
|
+
delta_rule: "NEVER restate full feature behavior; describe ONLY what changes"
|
|
53
|
+
required_sections:
|
|
54
|
+
- User Story
|
|
55
|
+
- Linked Epic
|
|
56
|
+
- Feature Impact
|
|
57
|
+
- Acceptance Criteria
|
|
58
|
+
optional_sections:
|
|
59
|
+
- Technical Notes
|
|
60
|
+
- UX & Copy
|
|
61
|
+
---
|
|
62
|
+
|
|
1
63
|
# Story: `s-eXXX-YYY-description`
|
|
2
64
|
|
|
3
65
|
<!--
|
|
@@ -18,8 +80,8 @@
|
|
|
18
80
|
- TS-STORY-003: Acceptance Criteria required
|
|
19
81
|
-->
|
|
20
82
|
|
|
21
|
-
> **Template Version**: 4.0
|
|
22
|
-
> **Last Updated**: 2026-01-
|
|
83
|
+
> **Template Version**: 4.0.1
|
|
84
|
+
> **Last Updated**: 2026-01-12
|
|
23
85
|
|
|
24
86
|
---
|
|
25
87
|
|
|
@@ -73,8 +135,9 @@
|
|
|
73
135
|
|
|
74
136
|
## Feature Impact
|
|
75
137
|
|
|
76
|
-
>
|
|
77
|
-
> **
|
|
138
|
+
> **Contract:** Describes ONLY what this story changes relative to current documented behavior.
|
|
139
|
+
> **Required precision:** Reference specific feature section; use AS-IS/TO-BE format.
|
|
140
|
+
> **Not this:** Full behavior restatement, implementation details, or technical approach.
|
|
78
141
|
|
|
79
142
|
<!-- TEAMSPEC RULE: TS-STORY-002 requires Before/After (AS-IS/TO-BE) format -->
|
|
80
143
|
|
|
@@ -131,6 +194,10 @@
|
|
|
131
194
|
|
|
132
195
|
## Acceptance Criteria (AC)
|
|
133
196
|
|
|
197
|
+
> **Contract:** Testable conditions that define "done" for this story.
|
|
198
|
+
> **Required precision:** Gherkin format (Given/When/Then) or explicit checklist.
|
|
199
|
+
> **Not this:** Vague descriptions, implementation tasks, or test scripts.
|
|
200
|
+
>
|
|
134
201
|
> ⚠️ **MANDATORY**: AC must be present and testable.
|
|
135
202
|
> **TEAMSPEC RULE:** TS-STORY-003 - AC required
|
|
136
203
|
|
|
@@ -1,4 +1,37 @@
|
|
|
1
1
|
---
|
|
2
|
+
artifact_kind: storymap
|
|
3
|
+
spec_version: "4.0"
|
|
4
|
+
template_version: "4.0.1"
|
|
5
|
+
role_owner: PO
|
|
6
|
+
keywords:
|
|
7
|
+
- story map
|
|
8
|
+
- user story mapping
|
|
9
|
+
- backbone activities
|
|
10
|
+
- feature slicing
|
|
11
|
+
- story candidates
|
|
12
|
+
- release planning
|
|
13
|
+
- story prioritization
|
|
14
|
+
- mvp planning
|
|
15
|
+
- user journey
|
|
16
|
+
- feature decomposition
|
|
17
|
+
anti_keywords:
|
|
18
|
+
- sprint planning
|
|
19
|
+
- technical design
|
|
20
|
+
- architecture
|
|
21
|
+
- test cases
|
|
22
|
+
- bug report
|
|
23
|
+
links_required:
|
|
24
|
+
- type: epic
|
|
25
|
+
pattern: "epics/EPIC-*.md"
|
|
26
|
+
- type: feature
|
|
27
|
+
pattern: "features/F-*.md"
|
|
28
|
+
completion_rules:
|
|
29
|
+
epic_link_rule: "Must link to parent Epic"
|
|
30
|
+
feature_link_rule: "Story candidates must reference Feature IDs"
|
|
31
|
+
slice_rule: "Each story candidate must belong to a feature slice"
|
|
32
|
+
---
|
|
33
|
+
# Story Map Document
|
|
34
|
+
---
|
|
2
35
|
epic_id: "[EPIC-ID]"
|
|
3
36
|
epic_name: "[Epic Name]"
|
|
4
37
|
goal: "[One-sentence business goal]"
|
|
@@ -1,3 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
# === LLM Retrieval Metadata ===
|
|
3
|
+
artifact_kind: ta
|
|
4
|
+
spec_version: "4.0"
|
|
5
|
+
template_version: "4.0.1"
|
|
6
|
+
|
|
7
|
+
# === Ownership ===
|
|
8
|
+
role_owner: SA
|
|
9
|
+
artifact_type: Product Canon
|
|
10
|
+
canonicity: canon
|
|
11
|
+
lifecycle: permanent
|
|
12
|
+
|
|
13
|
+
# === Naming ===
|
|
14
|
+
id_pattern: "ta-{PRX}-{NNN}"
|
|
15
|
+
filename_pattern: "ta-{PRX}-{NNN}-{description}.md"
|
|
16
|
+
|
|
17
|
+
# === Required Relationships ===
|
|
18
|
+
links_required:
|
|
19
|
+
- type: product
|
|
20
|
+
pattern: "product.yml"
|
|
21
|
+
optional: false
|
|
22
|
+
- type: feature
|
|
23
|
+
pattern: "f-{PRX}-{NNN}"
|
|
24
|
+
optional: true
|
|
25
|
+
note: "Link to affected features"
|
|
26
|
+
|
|
27
|
+
# === Search Optimization ===
|
|
28
|
+
keywords:
|
|
29
|
+
- technical architecture
|
|
30
|
+
- ADR
|
|
31
|
+
- architecture decision
|
|
32
|
+
- constraints
|
|
33
|
+
- patterns
|
|
34
|
+
- technical design
|
|
35
|
+
aliases:
|
|
36
|
+
- architecture document
|
|
37
|
+
- technical decision record
|
|
38
|
+
anti_keywords:
|
|
39
|
+
- business requirements
|
|
40
|
+
- user behavior
|
|
41
|
+
- story
|
|
42
|
+
- feature behavior
|
|
43
|
+
|
|
44
|
+
# === Generation Contract ===
|
|
45
|
+
completion_rules:
|
|
46
|
+
placeholders: "Fill {braces} only; leave {TBD} if unknown"
|
|
47
|
+
required_sections:
|
|
48
|
+
- Context
|
|
49
|
+
- Decision
|
|
50
|
+
- Consequences
|
|
51
|
+
optional_sections:
|
|
52
|
+
- Alternatives Considered
|
|
53
|
+
- Related Decisions
|
|
54
|
+
---
|
|
55
|
+
|
|
1
56
|
# Technical Architecture: `ta-{PRX}-{NNN}-{description}`
|
|
2
57
|
|
|
3
58
|
<!--
|
|
@@ -45,6 +100,10 @@
|
|
|
45
100
|
|
|
46
101
|
## Context
|
|
47
102
|
|
|
103
|
+
> **Contract:** The technical situation requiring a decision.
|
|
104
|
+
> **Required precision:** Problem statement, constraints, forces.
|
|
105
|
+
> **Not this:** The solution itself or implementation details.
|
|
106
|
+
|
|
48
107
|
> What is the problem? Why do we need to make a technical decision?
|
|
49
108
|
|
|
50
109
|
[Describe the technical situation, constraints, and forces that require a decision.]
|
|
@@ -79,6 +138,10 @@
|
|
|
79
138
|
|
|
80
139
|
## Decision
|
|
81
140
|
|
|
141
|
+
> **Contract:** The chosen option and why.
|
|
142
|
+
> **Required precision:** Clear statement of choice with primary rationale.
|
|
143
|
+
> **Not this:** Detailed implementation, code samples.
|
|
144
|
+
|
|
82
145
|
> We are choosing **Option X** because...
|
|
83
146
|
|
|
84
147
|
[Clear statement of the decision and primary rationale]
|
|
@@ -87,6 +150,10 @@
|
|
|
87
150
|
|
|
88
151
|
## Consequences
|
|
89
152
|
|
|
153
|
+
> **Contract:** Trade-offs accepted by this decision.
|
|
154
|
+
> **Required precision:** Specific positive and negative impacts.
|
|
155
|
+
> **Not this:** Vague "may impact performance" statements.
|
|
156
|
+
|
|
90
157
|
### Positive
|
|
91
158
|
|
|
92
159
|
- [Benefit 1]
|
|
@@ -1,4 +1,53 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
# === LLM Retrieval Metadata ===
|
|
3
|
+
artifact_kind: tai
|
|
4
|
+
spec_version: "4.0"
|
|
5
|
+
template_version: "4.0.1"
|
|
6
|
+
|
|
7
|
+
# === Ownership ===
|
|
8
|
+
role_owner: SA
|
|
9
|
+
artifact_type: Project Execution
|
|
10
|
+
canonicity: project-execution
|
|
11
|
+
lifecycle: project-bound
|
|
12
|
+
|
|
13
|
+
# === Naming ===
|
|
14
|
+
id_pattern: "tai-{PRX}-{NNN}"
|
|
15
|
+
filename_pattern: "tai-{PRX}-{NNN}-{description}.md"
|
|
16
|
+
|
|
17
|
+
# === Required Relationships ===
|
|
18
|
+
links_required:
|
|
19
|
+
- type: technical-architecture
|
|
20
|
+
pattern: "ta-{PRX}-{NNN}"
|
|
21
|
+
optional: false
|
|
22
|
+
- type: feature-increment
|
|
23
|
+
pattern: "fi-{PRX}-{NNN}"
|
|
24
|
+
optional: true
|
|
25
|
+
|
|
26
|
+
# === Search Optimization ===
|
|
27
|
+
keywords:
|
|
28
|
+
- technical architecture increment
|
|
29
|
+
- TAI
|
|
30
|
+
- architecture delta
|
|
31
|
+
- technical change
|
|
32
|
+
aliases:
|
|
33
|
+
- architecture change proposal
|
|
34
|
+
anti_keywords:
|
|
35
|
+
- business requirements
|
|
36
|
+
- story
|
|
37
|
+
- feature behavior
|
|
38
|
+
|
|
39
|
+
# === Generation Contract ===
|
|
40
|
+
completion_rules:
|
|
41
|
+
placeholders: "Fill {braces} only"
|
|
42
|
+
required_sections:
|
|
43
|
+
- Overview
|
|
44
|
+
- AS-IS
|
|
45
|
+
- TO-BE
|
|
46
|
+
optional_sections:
|
|
47
|
+
- Risks
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
# Technical Architecture Increment: `tai-{PRX}-{NNN}-{description}`
|
|
2
51
|
|
|
3
52
|
> **ID:** tai-PRX-XXX
|
|
4
53
|
> **Product:** `<product-id>` (PRX)
|
|
@@ -30,12 +79,20 @@
|
|
|
30
79
|
|
|
31
80
|
## 1. Overview
|
|
32
81
|
|
|
82
|
+
> **Contract:** Summary of this architecture increment.
|
|
83
|
+
> **Required precision:** What changes and why for this project.
|
|
84
|
+
> **Not this:** Full TA document (that's the Product TA).
|
|
85
|
+
|
|
33
86
|
_Brief description of the technical architecture increment specific to this project._
|
|
34
87
|
|
|
35
88
|
---
|
|
36
89
|
|
|
37
90
|
## 2. AS-IS (Current Product TA)
|
|
38
91
|
|
|
92
|
+
> **Contract:** Current production architecture state.
|
|
93
|
+
> **Required precision:** Copy from Product TA, do not paraphrase.
|
|
94
|
+
> **Not this:** Proposed changes (those go in TO-BE).
|
|
95
|
+
|
|
39
96
|
> _Auto-populated from Product Technical Architecture. DO NOT EDIT unless correcting errors._
|
|
40
97
|
|
|
41
98
|
_Copy relevant sections from the Product TA._
|
|
@@ -44,6 +101,10 @@ _Copy relevant sections from the Product TA._
|
|
|
44
101
|
|
|
45
102
|
## 3. TO-BE (Project Technical Architecture)
|
|
46
103
|
|
|
104
|
+
> **Contract:** Proposed architecture after this increment.
|
|
105
|
+
> **Required precision:** Specific changes, not full restatement.
|
|
106
|
+
> **Not this:** Current state (that's AS-IS).
|
|
107
|
+
|
|
47
108
|
### 3.1 New/Changed Architecture Elements
|
|
48
109
|
|
|
49
110
|
_Describe what the project-specific architecture includes that product architecture doesn't._
|
|
@@ -1,4 +1,55 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
# === LLM Retrieval Metadata ===
|
|
3
|
+
artifact_kind: tc
|
|
4
|
+
spec_version: "4.0"
|
|
5
|
+
template_version: "4.0.1"
|
|
6
|
+
|
|
7
|
+
# === Ownership ===
|
|
8
|
+
role_owner: QA
|
|
9
|
+
artifact_type: Project Execution
|
|
10
|
+
canonicity: project-execution
|
|
11
|
+
lifecycle: project-bound
|
|
12
|
+
|
|
13
|
+
# === Naming ===
|
|
14
|
+
id_pattern: "tc-fi-{PRX}-{NNN}"
|
|
15
|
+
filename_pattern: "tc-fi-{PRX}-{NNN}-{description}.md"
|
|
16
|
+
|
|
17
|
+
# === Required Relationships ===
|
|
18
|
+
links_required:
|
|
19
|
+
- type: feature-increment
|
|
20
|
+
pattern: "fi-{PRX}-{NNN}"
|
|
21
|
+
optional: false
|
|
22
|
+
- type: feature
|
|
23
|
+
pattern: "f-{PRX}-{NNN}"
|
|
24
|
+
optional: true
|
|
25
|
+
|
|
26
|
+
# === Search Optimization ===
|
|
27
|
+
keywords:
|
|
28
|
+
- test case
|
|
29
|
+
- test scenario
|
|
30
|
+
- validation
|
|
31
|
+
- verification
|
|
32
|
+
- acceptance test
|
|
33
|
+
aliases:
|
|
34
|
+
- test spec
|
|
35
|
+
- test script
|
|
36
|
+
anti_keywords:
|
|
37
|
+
- regression test
|
|
38
|
+
- automated test code
|
|
39
|
+
- unit test
|
|
40
|
+
|
|
41
|
+
# === Generation Contract ===
|
|
42
|
+
completion_rules:
|
|
43
|
+
placeholders: "Fill {braces} only"
|
|
44
|
+
required_sections:
|
|
45
|
+
- Test Case Reference
|
|
46
|
+
- Test Scenarios
|
|
47
|
+
optional_sections:
|
|
48
|
+
- Test Data
|
|
49
|
+
- Automation Notes
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
# Test Cases: `tc-fi-{PRX}-{NNN}-{description}`
|
|
2
53
|
|
|
3
54
|
<!--
|
|
4
55
|
⚠️ PROJECT-LEVEL TEST CASES
|
|
@@ -47,6 +98,10 @@
|
|
|
47
98
|
|
|
48
99
|
## Test Scenarios
|
|
49
100
|
|
|
101
|
+
> **Contract:** Specific test cases validating FI behavior.
|
|
102
|
+
> **Required precision:** Steps, expected results, AC mapping.
|
|
103
|
+
> **Not this:** Automation code or unit tests.
|
|
104
|
+
|
|
50
105
|
### TC-001: [Title]
|
|
51
106
|
|
|
52
107
|
- **Type**: Positive / Negative / Boundary
|