teamspec 3.2.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/LICENSE +21 -0
- package/README.md +252 -0
- package/bin/teamspec-init.js +10 -0
- package/extensions/teamspec-0.1.0.vsix +0 -0
- package/lib/cli.js +1174 -0
- package/lib/extension-installer.js +236 -0
- package/lib/linter.js +1184 -0
- package/lib/prompt-generator.js +409 -0
- package/package.json +51 -0
- package/teamspec-core/agents/AGENT_BA.md +486 -0
- package/teamspec-core/agents/AGENT_BOOTSTRAP.md +447 -0
- package/teamspec-core/agents/AGENT_DES.md +623 -0
- package/teamspec-core/agents/AGENT_DEV.md +611 -0
- package/teamspec-core/agents/AGENT_FA.md +736 -0
- package/teamspec-core/agents/AGENT_FEEDBACK.md +202 -0
- package/teamspec-core/agents/AGENT_FIX.md +380 -0
- package/teamspec-core/agents/AGENT_QA.md +756 -0
- package/teamspec-core/agents/AGENT_SA.md +581 -0
- package/teamspec-core/agents/AGENT_SM.md +771 -0
- package/teamspec-core/agents/README.md +383 -0
- package/teamspec-core/context/_schema.yml +222 -0
- package/teamspec-core/copilot-instructions.md +356 -0
- package/teamspec-core/definitions/definition-of-done.md +129 -0
- package/teamspec-core/definitions/definition-of-ready.md +104 -0
- package/teamspec-core/profiles/enterprise.yml +127 -0
- package/teamspec-core/profiles/platform-team.yml +104 -0
- package/teamspec-core/profiles/regulated.yml +97 -0
- package/teamspec-core/profiles/startup.yml +85 -0
- package/teamspec-core/teamspec.yml +69 -0
- package/teamspec-core/templates/README.md +211 -0
- package/teamspec-core/templates/active-sprint-template.md +98 -0
- package/teamspec-core/templates/adr-template.md +194 -0
- package/teamspec-core/templates/bug-report-template.md +188 -0
- package/teamspec-core/templates/business-analysis-template.md +164 -0
- package/teamspec-core/templates/decision-log-template.md +216 -0
- package/teamspec-core/templates/feature-template.md +269 -0
- package/teamspec-core/templates/functional-spec-template.md +161 -0
- package/teamspec-core/templates/refinement-notes-template.md +133 -0
- package/teamspec-core/templates/sprint-goal-template.md +129 -0
- package/teamspec-core/templates/sprint-template.md +175 -0
- package/teamspec-core/templates/sprints-index-template.md +67 -0
- package/teamspec-core/templates/story-template.md +244 -0
- package/teamspec-core/templates/storymap-template.md +204 -0
- package/teamspec-core/templates/testcases-template.md +147 -0
- package/teamspec-core/templates/uat-pack-template.md +161 -0
|
@@ -0,0 +1,356 @@
|
|
|
1
|
+
# Copilot Instructions for TeamSpec 2.0
|
|
2
|
+
|
|
3
|
+
> **Version:** 2.0
|
|
4
|
+
> **Last Updated:** 2026-01-08
|
|
5
|
+
> **Status:** Active (Installed Instance)
|
|
6
|
+
|
|
7
|
+
You are an expert Agile assistant working in a **TeamSpec 2.0** enabled workspace — utilizing the Feature Canon operating model for requirements management.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## What is TeamSpec?
|
|
12
|
+
|
|
13
|
+
TeamSpec is an operating model that treats the **Feature Canon** as the SINGLE SOURCE OF TRUTH for all system behavior. All other artifacts (stories, test cases, dev plans) derive from or reference it.
|
|
14
|
+
|
|
15
|
+
### Core Principle
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
The Feature Canon is the SINGLE SOURCE OF TRUTH for all system behavior.
|
|
19
|
+
Everything else derives from or references it.
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Workspace Structure
|
|
25
|
+
|
|
26
|
+
This workspace uses TeamSpec with the following structure:
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
.teamspec/ # Core framework (installed)
|
|
30
|
+
├── templates/ # Document templates for all artifacts
|
|
31
|
+
├── definitions/ # DoR/DoD checklists
|
|
32
|
+
├── profiles/ # Profile overlays (regulated, startup, etc.)
|
|
33
|
+
└── context/ # Team configuration and custom rules
|
|
34
|
+
├── team.yml # Team metadata and preferences
|
|
35
|
+
└── _schema.yml # Context schema definition
|
|
36
|
+
|
|
37
|
+
projects/<project-id>/ # Project artifacts
|
|
38
|
+
├── project.yml # Project metadata (REQUIRED)
|
|
39
|
+
├── features/ # Feature Canon (source of truth)
|
|
40
|
+
│ ├── F-001-feature.md
|
|
41
|
+
│ ├── features-index.md
|
|
42
|
+
│ └── story-ledger.md
|
|
43
|
+
├── stories/ # Workflow folders
|
|
44
|
+
│ ├── backlog/ # FA creates here
|
|
45
|
+
│ ├── ready-to-refine/ # FA moves here for refinement
|
|
46
|
+
│ └── ready-for-development/ # DEV moves here when ready
|
|
47
|
+
├── adr/ # Architecture Decision Records
|
|
48
|
+
├── decisions/ # Business decisions
|
|
49
|
+
├── dev-plans/ # Development task breakdowns
|
|
50
|
+
├── qa/test-cases/ # Test documentation
|
|
51
|
+
├── epics/ # Epic definitions
|
|
52
|
+
└── sprints/ # Sprint folders
|
|
53
|
+
└── sprint-N/sprint-goal.md
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Document Hierarchy
|
|
59
|
+
|
|
60
|
+
| Level | Artifacts | Owner | Purpose |
|
|
61
|
+
|-------|-----------|-------|---------|
|
|
62
|
+
| **Source of Truth** | Feature Canon, Decision Log, ADR | BA/FA/SA | Defines WHAT exists |
|
|
63
|
+
| **Execution** | Stories, Dev Plans, Test Cases | FA/DEV/QA | Defines WHAT to change |
|
|
64
|
+
| **Operational** | Sprints, Status Reports | SM | Tracks progress |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Role Boundaries (STRICT)
|
|
69
|
+
|
|
70
|
+
| Role | Owns | Does NOT Own |
|
|
71
|
+
|------|------|--------------|
|
|
72
|
+
| **BA** | Purpose, Value, Scope, Business Decisions | Technical design, Implementation |
|
|
73
|
+
| **FA** | Behavior, Flows, Business Rules, Stories | Architecture, Code |
|
|
74
|
+
| **SA** | Architecture, ADRs, Technical Decisions | Business requirements |
|
|
75
|
+
| **DEV** | Implementation, Dev Plans | Functional requirements |
|
|
76
|
+
| **QA** | Test Cases, Bug Reports | Feature definitions |
|
|
77
|
+
| **SM** | Sprint Management, Process | Content of deliverables |
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Story-as-Delta Philosophy
|
|
82
|
+
|
|
83
|
+
Stories describe **CHANGES** to the Feature Canon:
|
|
84
|
+
- **Before:** Reference current Canon behavior
|
|
85
|
+
- **After:** Describe the delta (new/changed behavior)
|
|
86
|
+
- **Impact:** Which Canon sections are affected
|
|
87
|
+
|
|
88
|
+
**Example:**
|
|
89
|
+
```markdown
|
|
90
|
+
## Before
|
|
91
|
+
Users can only log in with email/password (per F-001-authentication §2.1)
|
|
92
|
+
|
|
93
|
+
## After
|
|
94
|
+
Users can also log in with Google OAuth (adds new flow to F-001-authentication §2.3)
|
|
95
|
+
|
|
96
|
+
## Impact
|
|
97
|
+
- F-001-authentication: New section 2.3 "OAuth Login Flow"
|
|
98
|
+
- F-001-authentication: Modified section 3.1 "Security Rules" to include OAuth tokens
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Agent System
|
|
104
|
+
|
|
105
|
+
TeamSpec uses **role-specific agents** located in `.teamspec/agents/`:
|
|
106
|
+
|
|
107
|
+
| Agent | File | Purpose |
|
|
108
|
+
|-------|------|---------|
|
|
109
|
+
| Bootstrap | `AGENT_BOOTSTRAP.md` | Core rules inherited by all agents |
|
|
110
|
+
| BA | `AGENT_BA.md` | Business Analysis tasks |
|
|
111
|
+
| FA | `AGENT_FA.md` | Functional Analysis tasks |
|
|
112
|
+
| SA | `AGENT_SA.md` | Solution Architecture tasks |
|
|
113
|
+
| DEV | `AGENT_DEV.md` | Development tasks |
|
|
114
|
+
| QA | `AGENT_QA.md` | Quality Assurance tasks |
|
|
115
|
+
| SM | `AGENT_SM.md` | Scrum Master tasks |
|
|
116
|
+
| DES | `AGENT_DES.md` | Design tasks |
|
|
117
|
+
| FIX | `AGENT_FIX.md` | Auto-fix linting errors |
|
|
118
|
+
|
|
119
|
+
### Using Agents
|
|
120
|
+
|
|
121
|
+
To invoke an agent's capabilities:
|
|
122
|
+
```
|
|
123
|
+
ts:agent <role> # Load role-specific agent
|
|
124
|
+
ts:agent fix # Run linter fix agent
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Command Reference
|
|
130
|
+
|
|
131
|
+
### CLI Commands (Terminal)
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
teamspec lint # Lint all projects against TeamSpec rules
|
|
135
|
+
teamspec lint --project X # Lint specific project
|
|
136
|
+
teamspec update # Update TeamSpec core files
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Copilot Commands (Chat)
|
|
140
|
+
|
|
141
|
+
#### Agent Commands
|
|
142
|
+
- `ts:agent ba` → Load BA agent from `.teamspec/agents/AGENT_BA.md`
|
|
143
|
+
- `ts:agent fa` → Load FA agent from `.teamspec/agents/AGENT_FA.md`
|
|
144
|
+
- `ts:agent dev` → Load DEV agent from `.teamspec/agents/AGENT_DEV.md`
|
|
145
|
+
- `ts:agent qa` → Load QA agent from `.teamspec/agents/AGENT_QA.md`
|
|
146
|
+
- `ts:agent sm` → Load SM agent from `.teamspec/agents/AGENT_SM.md`
|
|
147
|
+
- `ts:agent sa` → Load SA agent from `.teamspec/agents/AGENT_SA.md`
|
|
148
|
+
- `ts:agent fix` → Load FIX agent, auto-fix lint errors
|
|
149
|
+
|
|
150
|
+
#### BA Commands (Business Analysis)
|
|
151
|
+
- `ts:ba project` → Create/manage project structure
|
|
152
|
+
- `ts:ba epic` → Propose epic structure
|
|
153
|
+
- `ts:ba feature` → Extract feature from requirements
|
|
154
|
+
- `ts:ba decision` → Log business decision
|
|
155
|
+
- `ts:ba analysis` → Create business analysis document (process documentation)
|
|
156
|
+
|
|
157
|
+
#### FA Commands (Functional Analysis)
|
|
158
|
+
- `ts:fa story` → Create story in backlog
|
|
159
|
+
- `ts:fa slice` → Slice requirements into stories
|
|
160
|
+
- `ts:fa refine` → Move story to ready-to-refine
|
|
161
|
+
- `ts:fa sync` → Update Feature Canon after story completion
|
|
162
|
+
|
|
163
|
+
#### DEV Commands (Development)
|
|
164
|
+
- `ts:dev plan` → Create dev plan for story
|
|
165
|
+
- `ts:dev implement` → Execute implementation
|
|
166
|
+
- `ts:dev ready` → Move story to ready-for-development
|
|
167
|
+
|
|
168
|
+
#### QA Commands (Quality Assurance)
|
|
169
|
+
- `ts:qa test` → Design test cases
|
|
170
|
+
- `ts:qa dor-check` → Validate Definition of Ready
|
|
171
|
+
- `ts:qa dod-check` → Validate Definition of Done
|
|
172
|
+
|
|
173
|
+
#### SM Commands (Scrum Master)
|
|
174
|
+
- `ts:sm sprint create` → Create new sprint
|
|
175
|
+
- `ts:sm sprint plan` → Plan sprint backlog
|
|
176
|
+
- `ts:sm sprint close` → Close sprint with metrics
|
|
177
|
+
|
|
178
|
+
#### Universal Commands
|
|
179
|
+
- `ts:status` → Project status overview
|
|
180
|
+
- `ts:lint` → Run linter (equivalent to `teamspec lint`)
|
|
181
|
+
- `ts:fix` → Auto-fix lint errors (invokes AGENT_FIX)
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Linting Rules
|
|
186
|
+
|
|
187
|
+
The TeamSpec linter enforces these rule categories:
|
|
188
|
+
|
|
189
|
+
| Category | Rules | Severity |
|
|
190
|
+
|----------|-------|----------|
|
|
191
|
+
| **TS-PROJ** | Project registration, project.yml metadata | ERROR |
|
|
192
|
+
| **TS-FEAT** | Feature file existence, required sections, unique IDs | ERROR |
|
|
193
|
+
| **TS-STORY** | Feature links, delta format, AC, DoR | ERROR |
|
|
194
|
+
| **TS-ADR** | ADR requirements, feature linking | ERROR |
|
|
195
|
+
| **TS-DEVPLAN** | Dev plan existence for sprint stories | ERROR |
|
|
196
|
+
| **TS-DOD** | Canon sync when behavior changes | BLOCKER |
|
|
197
|
+
| **TS-NAMING** | File naming conventions | WARNING |
|
|
198
|
+
|
|
199
|
+
### Running the Linter
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
# From any TeamSpec-enabled workspace:
|
|
203
|
+
teamspec lint
|
|
204
|
+
|
|
205
|
+
# For specific project:
|
|
206
|
+
teamspec lint --project acme-webshop
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Auto-Fixing Lint Errors
|
|
210
|
+
|
|
211
|
+
Use the FIX agent to automatically resolve lint errors:
|
|
212
|
+
```
|
|
213
|
+
ts:agent fix
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Or manually follow the rules in `.teamspec/agents/AGENT_FIX.md`.
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
## Naming Conventions
|
|
221
|
+
|
|
222
|
+
| Artifact | Pattern | Example |
|
|
223
|
+
|----------|---------|---------|
|
|
224
|
+
| Feature | `F-NNN-description.md` | `F-001-user-auth.md` |
|
|
225
|
+
| Story | `S-NNN-description.md` | `S-042-password-reset.md` |
|
|
226
|
+
| ADR | `ADR-NNN-description.md` | `ADR-003-jwt-tokens.md` |
|
|
227
|
+
| Decision | `DECISION-NNN-description.md` | `DECISION-015-pricing.md` |
|
|
228
|
+
| Dev Plan | `story-NNN-tasks.md` | `story-042-tasks.md` |
|
|
229
|
+
| Epic | `EPIC-NNN-description.md` | `EPIC-002-checkout.md` |
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
## Quality Gates
|
|
234
|
+
|
|
235
|
+
### Definition of Ready (DoR)
|
|
236
|
+
|
|
237
|
+
Before a story enters `ready-for-development/`:
|
|
238
|
+
- [ ] Linked to Feature Canon
|
|
239
|
+
- [ ] Before/After delta clearly described
|
|
240
|
+
- [ ] Acceptance Criteria are testable
|
|
241
|
+
- [ ] No TBD/placeholder content
|
|
242
|
+
- [ ] Estimate assigned
|
|
243
|
+
|
|
244
|
+
### Definition of Done (DoD)
|
|
245
|
+
|
|
246
|
+
Before a story is marked Done:
|
|
247
|
+
- [ ] All AC verified
|
|
248
|
+
- [ ] Code reviewed and merged
|
|
249
|
+
- [ ] Tests passing
|
|
250
|
+
- [ ] **Feature Canon updated** (if behavior changed)
|
|
251
|
+
- [ ] Documentation updated
|
|
252
|
+
|
|
253
|
+
---
|
|
254
|
+
|
|
255
|
+
## Templates
|
|
256
|
+
|
|
257
|
+
All document templates are available in `.teamspec/templates/`:
|
|
258
|
+
|
|
259
|
+
- `feature-template.md` → Feature Canon entries
|
|
260
|
+
- `story-template.md` → User stories
|
|
261
|
+
- `adr-template.md` → Architecture Decision Records
|
|
262
|
+
- `decision-log-template.md` → Business decisions
|
|
263
|
+
- `sprint-goal-template.md` → Sprint goals
|
|
264
|
+
- `testcases-template.md` → Test cases
|
|
265
|
+
- `bug-report-template.md` → Bug reports
|
|
266
|
+
- `business-analysis-template.md` → Business analysis documents
|
|
267
|
+
|
|
268
|
+
### Using Templates
|
|
269
|
+
|
|
270
|
+
When creating artifacts, always reference the appropriate template:
|
|
271
|
+
```
|
|
272
|
+
ts:fa story # Uses story-template.md
|
|
273
|
+
ts:ba feature # Uses feature-template.md
|
|
274
|
+
ts:sa adr # Uses adr-template.md
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
## Output Guidelines
|
|
280
|
+
|
|
281
|
+
When assisting with TeamSpec:
|
|
282
|
+
|
|
283
|
+
1. **Template First**: Always use templates from `.teamspec/templates/`
|
|
284
|
+
2. **No Placeholders**: Never leave TBD/TODO unless explicitly asked
|
|
285
|
+
3. **Markdown Strict**: Output properly formatted Markdown
|
|
286
|
+
4. **Feature Canon Reference**: Always link behavior to Feature Canon
|
|
287
|
+
5. **Role Awareness**: Ask which role the user is acting as if unclear
|
|
288
|
+
6. **Delta Format**: Stories MUST describe changes (before/after/impact)
|
|
289
|
+
7. **Unique IDs**: Ensure all artifacts have unique sequential IDs
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## Team Context
|
|
294
|
+
|
|
295
|
+
This workspace has been configured with team-specific context in `.teamspec/context/team.yml`:
|
|
296
|
+
|
|
297
|
+
```yaml
|
|
298
|
+
# View your team's configuration:
|
|
299
|
+
cat .teamspec/context/team.yml
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
Team context includes:
|
|
303
|
+
- Organization and team name
|
|
304
|
+
- Selected profile (regulated, startup, platform-team, enterprise)
|
|
305
|
+
- Development cadence (Scrum, Kanban, Scrumban)
|
|
306
|
+
- Sprint length (if applicable)
|
|
307
|
+
- Industry and compliance requirements
|
|
308
|
+
|
|
309
|
+
**Always respect the team context when making suggestions.**
|
|
310
|
+
|
|
311
|
+
---
|
|
312
|
+
|
|
313
|
+
## Common Workflows
|
|
314
|
+
|
|
315
|
+
### Creating a New Feature
|
|
316
|
+
1. Use `ts:ba feature` to extract from requirements
|
|
317
|
+
2. Save to `projects/<project-id>/features/F-NNN-description.md`
|
|
318
|
+
3. Update `features-index.md` with new feature entry
|
|
319
|
+
4. Link from related stories
|
|
320
|
+
|
|
321
|
+
### Creating a New Story
|
|
322
|
+
1. Use `ts:fa story` to create in `stories/backlog/`
|
|
323
|
+
2. Ensure Before/After/Impact sections reference Feature Canon
|
|
324
|
+
3. Define testable Acceptance Criteria
|
|
325
|
+
4. Move to `ready-to-refine/` when ready for refinement
|
|
326
|
+
|
|
327
|
+
### Completing a Story
|
|
328
|
+
1. Mark all AC as verified
|
|
329
|
+
2. **Update Feature Canon** if behavior changed
|
|
330
|
+
3. Create/update dev plan if needed
|
|
331
|
+
4. Run `teamspec lint` to verify compliance
|
|
332
|
+
5. Move story to Done
|
|
333
|
+
|
|
334
|
+
### Making Architecture Decisions
|
|
335
|
+
1. Use `ts:sa adr` to create ADR in `adr/`
|
|
336
|
+
2. Link to affected Feature Canon sections
|
|
337
|
+
3. Document decision, context, consequences
|
|
338
|
+
4. Update team.yml if needed
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
## Getting Help
|
|
343
|
+
|
|
344
|
+
- View all templates: `ls .teamspec/templates/`
|
|
345
|
+
- View agent prompts: `ls .teamspec/agents/`
|
|
346
|
+
- Check definitions: `cat .teamspec/definitions/definition-of-ready.md`
|
|
347
|
+
- Run linter: `teamspec lint`
|
|
348
|
+
- Update core files: `teamspec update`
|
|
349
|
+
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
## Version Information
|
|
353
|
+
|
|
354
|
+
This workspace is using **TeamSpec 2.0** (Feature Canon Operating Model).
|
|
355
|
+
|
|
356
|
+
For updates or issues, run `teamspec update` to get the latest core files.
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Definition of Done (DoD)
|
|
2
|
+
|
|
3
|
+
> **Version:** 2.0
|
|
4
|
+
> **Owner:** QA (validates completeness), SM (enforces at sprint close)
|
|
5
|
+
|
|
6
|
+
A story is **Done** when ALL of the following are satisfied.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Mandatory Checklist
|
|
11
|
+
|
|
12
|
+
### 1. Code Complete ✓
|
|
13
|
+
|
|
14
|
+
| Check | Required |
|
|
15
|
+
|-------|----------|
|
|
16
|
+
| All tasks in dev plan marked complete | ✓ |
|
|
17
|
+
| Code merged to main/develop branch | ✓ |
|
|
18
|
+
| No outstanding TODOs in code (for this story) | ✓ |
|
|
19
|
+
|
|
20
|
+
### 2. Tests Pass ✓
|
|
21
|
+
|
|
22
|
+
| Check | Required |
|
|
23
|
+
|-------|----------|
|
|
24
|
+
| Unit tests written and passing | ✓ |
|
|
25
|
+
| Integration tests passing (if applicable) | ✓ |
|
|
26
|
+
| Test coverage meets team threshold | ✓ |
|
|
27
|
+
|
|
28
|
+
**Linter Rule:** `TS-DOD-002` — Tests are feature-level
|
|
29
|
+
|
|
30
|
+
### 3. Code Reviewed ✓
|
|
31
|
+
|
|
32
|
+
| Check | Required |
|
|
33
|
+
|-------|----------|
|
|
34
|
+
| Pull request reviewed and approved | ✓ |
|
|
35
|
+
| All review comments addressed | ✓ |
|
|
36
|
+
| CI/CD pipeline passing | ✓ |
|
|
37
|
+
|
|
38
|
+
### 4. Acceptance Criteria Verified ✓
|
|
39
|
+
|
|
40
|
+
| Check | Required |
|
|
41
|
+
|-------|----------|
|
|
42
|
+
| All ACs tested and passing | ✓ |
|
|
43
|
+
| QA sign-off obtained | ✓ |
|
|
44
|
+
| No critical bugs outstanding | ✓ |
|
|
45
|
+
|
|
46
|
+
### 5. Feature Canon Updated ✓ (CRITICAL)
|
|
47
|
+
|
|
48
|
+
| Check | Required |
|
|
49
|
+
|-------|----------|
|
|
50
|
+
| Feature file updated to reflect new behavior | ✓ |
|
|
51
|
+
| Change Log entry added with story reference | ✓ |
|
|
52
|
+
| Story Ledger updated | ✓ |
|
|
53
|
+
| FA verified Canon sync | ✓ |
|
|
54
|
+
|
|
55
|
+
**Linter Rule:** `TS-DOD-001` — Canon sync required before Done
|
|
56
|
+
|
|
57
|
+
> ⚠️ **A story CANNOT be Done if it changes behavior and the Feature Canon is NOT updated.**
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Canon Sync Process
|
|
62
|
+
|
|
63
|
+
Before marking a story Done:
|
|
64
|
+
|
|
65
|
+
1. **FA runs `ts:fa sync`** — Updates Feature Canon
|
|
66
|
+
2. **FA updates Change Log** — Links to story ID
|
|
67
|
+
3. **FA updates Story Ledger** — Records in `features/story-ledger.md`
|
|
68
|
+
4. **QA verifies** — Tests match updated Canon
|
|
69
|
+
|
|
70
|
+
### Change Log Entry Format
|
|
71
|
+
|
|
72
|
+
```markdown
|
|
73
|
+
| Date | Story | Change Summary | Author |
|
|
74
|
+
|------|-------|----------------|--------|
|
|
75
|
+
| YYYY-MM-DD | S-XXX | Brief description | FA Name |
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Story Ledger Entry Format
|
|
79
|
+
|
|
80
|
+
```markdown
|
|
81
|
+
| Story ID | Title | Sprint | Features Modified | Merged Date |
|
|
82
|
+
|----------|-------|--------|-------------------|-------------|
|
|
83
|
+
| S-XXX | Story title | Sprint N | F-001, F-002 | YYYY-MM-DD |
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Optional (Profile-Dependent)
|
|
89
|
+
|
|
90
|
+
These checks apply based on team profile:
|
|
91
|
+
|
|
92
|
+
### Regulated Profile
|
|
93
|
+
|
|
94
|
+
| Check | Applies To |
|
|
95
|
+
|-------|------------|
|
|
96
|
+
| Compliance checklist signed off | regulated |
|
|
97
|
+
| Audit trail documented | regulated |
|
|
98
|
+
| Release notes updated | regulated |
|
|
99
|
+
|
|
100
|
+
### Enterprise Profile
|
|
101
|
+
|
|
102
|
+
| Check | Applies To |
|
|
103
|
+
|-------|------------|
|
|
104
|
+
| Documentation updated | enterprise |
|
|
105
|
+
| Stakeholder notification sent | enterprise |
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Sprint Close Verification
|
|
110
|
+
|
|
111
|
+
At sprint close, SM verifies:
|
|
112
|
+
|
|
113
|
+
| Check | Owner |
|
|
114
|
+
|-------|-------|
|
|
115
|
+
| All "Done" stories have Canon sync | SM |
|
|
116
|
+
| Story Ledger is current | FA |
|
|
117
|
+
| No orphan stories (behavior change without Canon update) | QA |
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Quick Reference
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
DoD = Code + Tests + Review + ACs + Feature Canon Updated
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
**Most Common Failure:** Story marked "Done" without updating Feature Canon.
|
|
128
|
+
|
|
129
|
+
If Canon is not updated, the story is **NOT DONE**.
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Definition of Ready (DoR)
|
|
2
|
+
|
|
3
|
+
> **Version:** 2.0
|
|
4
|
+
> **Owner:** FA (gates story readiness), SM (enforces in sprint planning)
|
|
5
|
+
|
|
6
|
+
A story is **Ready** for development when ALL of the following are satisfied.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Mandatory Checklist
|
|
11
|
+
|
|
12
|
+
### 1. Feature Canon Link ✓
|
|
13
|
+
|
|
14
|
+
| Check | Required |
|
|
15
|
+
|-------|----------|
|
|
16
|
+
| Story links to existing Feature(s) in Feature Canon | ✓ |
|
|
17
|
+
| Feature file exists in `features/` folder | ✓ |
|
|
18
|
+
| Feature link uses correct format: `[F-XXX](../../features/F-XXX-name.md)` | ✓ |
|
|
19
|
+
|
|
20
|
+
**Linter Rule:** `TS-STORY-001` — Feature link required
|
|
21
|
+
|
|
22
|
+
### 2. Delta Format ✓
|
|
23
|
+
|
|
24
|
+
| Check | Required |
|
|
25
|
+
|-------|----------|
|
|
26
|
+
| Story uses Before/After delta format | ✓ |
|
|
27
|
+
| "Before" section references Feature Canon | ✓ |
|
|
28
|
+
| "After" section describes ONLY the change | ✓ |
|
|
29
|
+
| Story does NOT restate full feature behavior | ✓ |
|
|
30
|
+
|
|
31
|
+
**Linter Rule:** `TS-STORY-002` — Delta-only format required
|
|
32
|
+
|
|
33
|
+
### 3. Acceptance Criteria ✓
|
|
34
|
+
|
|
35
|
+
| Check | Required |
|
|
36
|
+
|-------|----------|
|
|
37
|
+
| All ACs are testable (Given/When/Then or clear assertions) | ✓ |
|
|
38
|
+
| No ambiguous terms ("should work well", "user-friendly") | ✓ |
|
|
39
|
+
| ACs cover the delta, not the entire feature | ✓ |
|
|
40
|
+
|
|
41
|
+
**Linter Rule:** `TS-STORY-003` — ACs must be testable
|
|
42
|
+
|
|
43
|
+
### 4. FA Acceptance Gate ✓
|
|
44
|
+
|
|
45
|
+
| Check | Required |
|
|
46
|
+
|-------|----------|
|
|
47
|
+
| FA has reviewed and initialed the story | ✓ |
|
|
48
|
+
| FA confirms delta is correctly scoped | ✓ |
|
|
49
|
+
| FA confirms feature link is correct | ✓ |
|
|
50
|
+
|
|
51
|
+
**Gate:** FA Acceptance section complete in story
|
|
52
|
+
|
|
53
|
+
### 5. Dev Plan Exists ✓
|
|
54
|
+
|
|
55
|
+
| Check | Required |
|
|
56
|
+
|-------|----------|
|
|
57
|
+
| Dev plan file exists in `dev-plans/` | ✓ |
|
|
58
|
+
| Story links to dev plan | ✓ |
|
|
59
|
+
| Dev plan has no TBD/TODO items | ✓ |
|
|
60
|
+
|
|
61
|
+
**Linter Rule:** `TS-DEVPLAN-001` — Dev plan required before implementation
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Optional (Profile-Dependent)
|
|
66
|
+
|
|
67
|
+
These checks apply based on team profile:
|
|
68
|
+
|
|
69
|
+
### Regulated Profile
|
|
70
|
+
|
|
71
|
+
| Check | Applies To |
|
|
72
|
+
|-------|------------|
|
|
73
|
+
| Risk assessment completed | regulated |
|
|
74
|
+
| Compliance impact documented | regulated |
|
|
75
|
+
| Sign-off from compliance officer | regulated |
|
|
76
|
+
|
|
77
|
+
### Enterprise Profile
|
|
78
|
+
|
|
79
|
+
| Check | Applies To |
|
|
80
|
+
|-------|------------|
|
|
81
|
+
| Architecture review completed | enterprise |
|
|
82
|
+
| Cross-team dependencies identified | enterprise |
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Workflow Gate
|
|
87
|
+
|
|
88
|
+
Stories MUST be in `stories/ready-for-development/` folder to enter sprint.
|
|
89
|
+
|
|
90
|
+
| From Folder | To Folder | Owner |
|
|
91
|
+
|-------------|-----------|-------|
|
|
92
|
+
| `backlog/` | `ready-to-refine/` | FA |
|
|
93
|
+
| `ready-to-refine/` | `ready-for-development/` | DEV (after refinement) |
|
|
94
|
+
| `ready-for-development/` | Sprint | SM (sprint planning) |
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Quick Reference
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
DoR = Feature Link + Delta Format + Testable ACs + FA Gate + Dev Plan
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
If any check fails, the story is **NOT READY** for development.
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# Enterprise Profile
|
|
2
|
+
|
|
3
|
+
> **Version:** 2.0
|
|
4
|
+
> **Applies To:** Large organizations, multi-team environments, enterprise software
|
|
5
|
+
|
|
6
|
+
This profile adds governance, audit trails, and cross-team coordination.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Profile Characteristics
|
|
11
|
+
|
|
12
|
+
| Aspect | Configuration |
|
|
13
|
+
|--------|---------------|
|
|
14
|
+
| Governance Level | High |
|
|
15
|
+
| Sign-off Required | Yes |
|
|
16
|
+
| Audit Trail | Yes |
|
|
17
|
+
| Change Control Board | Optional |
|
|
18
|
+
| Documentation | Comprehensive |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Additional Checkpoints
|
|
23
|
+
|
|
24
|
+
### Definition of Ready Additions
|
|
25
|
+
|
|
26
|
+
| Check | Enforcement |
|
|
27
|
+
|-------|-------------|
|
|
28
|
+
| Architecture review completed | Required |
|
|
29
|
+
| Cross-team dependencies identified | Required |
|
|
30
|
+
| Stakeholder approval obtained | Required |
|
|
31
|
+
| Resource allocation confirmed | Required |
|
|
32
|
+
|
|
33
|
+
### Definition of Done Additions
|
|
34
|
+
|
|
35
|
+
| Check | Enforcement |
|
|
36
|
+
|-------|-------------|
|
|
37
|
+
| Documentation fully updated | Required |
|
|
38
|
+
| Stakeholder sign-off obtained | Required |
|
|
39
|
+
| Training materials updated (if user-facing) | Required |
|
|
40
|
+
| Release communication sent | Required |
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Required Artifacts
|
|
45
|
+
|
|
46
|
+
Enterprise stories SHOULD include:
|
|
47
|
+
|
|
48
|
+
1. **Stakeholder Section**
|
|
49
|
+
```markdown
|
|
50
|
+
## Stakeholders
|
|
51
|
+
|
|
52
|
+
| Stakeholder | Role | Sign-off Required |
|
|
53
|
+
|-------------|------|-------------------|
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
2. **Dependencies Section**
|
|
57
|
+
```markdown
|
|
58
|
+
## Dependencies
|
|
59
|
+
|
|
60
|
+
| Dependency | Team | Status |
|
|
61
|
+
|------------|------|--------|
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
3. **Communication Plan**
|
|
65
|
+
```markdown
|
|
66
|
+
## Communication Plan
|
|
67
|
+
|
|
68
|
+
- **Announcement Channel:** [Slack/Email/etc.]
|
|
69
|
+
- **Training Required:** [Yes/No]
|
|
70
|
+
- **Documentation Link:** [URL]
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Governance Structure
|
|
76
|
+
|
|
77
|
+
### Approval Hierarchy
|
|
78
|
+
|
|
79
|
+
| Artifact | Approver |
|
|
80
|
+
|----------|----------|
|
|
81
|
+
| Feature (new) | BA + Product Owner |
|
|
82
|
+
| Epic (new) | BA + Director |
|
|
83
|
+
| Architecture Decision | SA + Tech Lead |
|
|
84
|
+
| Story (high impact) | FA + BA |
|
|
85
|
+
|
|
86
|
+
### Review Cadence
|
|
87
|
+
|
|
88
|
+
| Review | Frequency | Participants |
|
|
89
|
+
|--------|-----------|--------------|
|
|
90
|
+
| Architecture Review | Weekly | SA, Tech Leads |
|
|
91
|
+
| Feature Review | Bi-weekly | BA, FA, Product |
|
|
92
|
+
| Sprint Review | End of sprint | Full team + stakeholders |
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Multi-Team Coordination
|
|
97
|
+
|
|
98
|
+
For stories affecting multiple teams:
|
|
99
|
+
|
|
100
|
+
1. **Identify teams** — List all affected teams
|
|
101
|
+
2. **Align sprints** — Coordinate timing
|
|
102
|
+
3. **Integration testing** — Plan cross-team testing
|
|
103
|
+
4. **Communication** — Establish sync meetings
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Feature Canon Requirements
|
|
108
|
+
|
|
109
|
+
For enterprise environments:
|
|
110
|
+
|
|
111
|
+
1. **Version control** — All changes tracked
|
|
112
|
+
2. **Approval history** — Who approved what
|
|
113
|
+
3. **Impact analysis** — Dependencies documented
|
|
114
|
+
4. **Traceability** — Link to business objectives
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Metrics and Reporting
|
|
119
|
+
|
|
120
|
+
Track and report:
|
|
121
|
+
|
|
122
|
+
| Metric | Purpose |
|
|
123
|
+
|--------|---------|
|
|
124
|
+
| Lead time | Story creation to deployment |
|
|
125
|
+
| Cycle time | Development start to deployment |
|
|
126
|
+
| Throughput | Stories per sprint |
|
|
127
|
+
| Canon coverage | % features documented |
|