agentic-team-templates 0.8.3 → 0.9.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.
@@ -0,0 +1,371 @@
1
+ # Requirements Documentation
2
+
3
+ Standards for PRDs, user stories, and specifications.
4
+
5
+ ## Core Principles
6
+
7
+ ### Living Documents
8
+
9
+ Requirements documents are not handoffs—they're living artifacts that evolve through collaboration. They should:
10
+
11
+ - Start as shared understanding, not mandates
12
+ - Update as learning occurs
13
+ - Include rationale, not just requirements
14
+ - Be accessible to all stakeholders
15
+
16
+ ### Right Level of Detail
17
+
18
+ | Audience | Detail Level | Focus |
19
+ |----------|--------------|-------|
20
+ | Executives | High-level | Outcomes, timeline, resources |
21
+ | Product Trio | Detailed | Problems, solutions, constraints |
22
+ | Engineering | Specific | Acceptance criteria, edge cases |
23
+
24
+ ## PRD Structure
25
+
26
+ ### PRD Template
27
+
28
+ ```markdown
29
+ # PRD: [Feature Name]
30
+
31
+ ## Metadata
32
+ - **Author**: [Name]
33
+ - **Status**: Draft | In Review | Approved | In Development | Shipped
34
+ - **Created**: [Date]
35
+ - **Last Updated**: [Date]
36
+ - **Reviewers**: [Names]
37
+
38
+ ---
39
+
40
+ ## Executive Summary
41
+ [2-3 sentences: What are we building and why?]
42
+
43
+ ---
44
+
45
+ ## Problem Statement
46
+
47
+ ### The Problem
48
+ [Describe the customer problem in their words]
49
+
50
+ ### Evidence
51
+ | Source | Finding |
52
+ |--------|---------|
53
+ | Customer interview | "[Quote]" |
54
+ | Analytics | [Data point] |
55
+ | Support tickets | [Trend] |
56
+
57
+ ### Impact of Not Solving
58
+ - Customer impact: [Description]
59
+ - Business impact: [Description]
60
+
61
+ ---
62
+
63
+ ## Goals & Success Metrics
64
+
65
+ ### Objectives
66
+ [What outcomes are we trying to achieve?]
67
+
68
+ ### Key Results
69
+ | Metric | Current | Target | Measurement Method |
70
+ |--------|---------|--------|-------------------|
71
+ | Primary KR | X | Y | [How measured] |
72
+ | Secondary KR | X | Y | [How measured] |
73
+
74
+ ### Non-Goals
75
+ [Explicitly state what this project will NOT address]
76
+
77
+ ---
78
+
79
+ ## User Stories
80
+
81
+ ### Persona: [Name]
82
+ **Background**: [Context about this user]
83
+
84
+ #### Story 1
85
+ **As a** [role],
86
+ **I want to** [action],
87
+ **So that** [benefit].
88
+
89
+ **Acceptance Criteria**:
90
+ - [ ] Given [context], when [action], then [result]
91
+ - [ ] Given [context], when [action], then [result]
92
+ - [ ] [Non-functional requirement]
93
+
94
+ #### Story 2
95
+ [Repeat format]
96
+
97
+ ---
98
+
99
+ ## Solution
100
+
101
+ ### Proposed Approach
102
+ [High-level description of the solution]
103
+
104
+ ### Key Screens/Flows
105
+ [Include wireframes, mockups, or links to designs]
106
+
107
+ ### User Flow
108
+ ```
109
+ [Start] → [Step 1] → [Decision Point] → [Step 2] → [End]
110
+
111
+ [Alternative Path]
112
+ ```
113
+
114
+ ---
115
+
116
+ ## Scope
117
+
118
+ ### In Scope
119
+ - [Feature/capability 1]
120
+ - [Feature/capability 2]
121
+ - [Feature/capability 3]
122
+
123
+ ### Out of Scope
124
+ - [Explicitly excluded item 1]
125
+ - [Explicitly excluded item 2]
126
+
127
+ ### Future Considerations
128
+ - [Potential follow-up 1]
129
+ - [Potential follow-up 2]
130
+
131
+ ---
132
+
133
+ ## Technical Considerations
134
+
135
+ ### Dependencies
136
+ | Dependency | Owner | Status | Risk |
137
+ |------------|-------|--------|------|
138
+ | [API/Service] | [Team] | [Ready/In Progress/Blocked] | [Risk] |
139
+
140
+ ### Technical Approach
141
+ [Notes from engineering on implementation approach]
142
+
143
+ ### Performance Requirements
144
+ - [Load time requirement]
145
+ - [Scalability requirement]
146
+
147
+ ### Security Considerations
148
+ - [Security requirement 1]
149
+ - [Security requirement 2]
150
+
151
+ ---
152
+
153
+ ## Timeline
154
+
155
+ | Milestone | Target Date | Owner | Status |
156
+ |-----------|-------------|-------|--------|
157
+ | PRD Approval | [Date] | PM | [Status] |
158
+ | Design Complete | [Date] | Design | [Status] |
159
+ | Development Start | [Date] | Engineering | [Status] |
160
+ | QA Complete | [Date] | QA | [Status] |
161
+ | Launch | [Date] | PM | [Status] |
162
+
163
+ ---
164
+
165
+ ## Risks & Mitigations
166
+
167
+ | Risk | Likelihood | Impact | Mitigation |
168
+ |------|------------|--------|------------|
169
+ | [Risk 1] | High/Med/Low | High/Med/Low | [Action] |
170
+ | [Risk 2] | High/Med/Low | High/Med/Low | [Action] |
171
+
172
+ ---
173
+
174
+ ## Open Questions
175
+ - [ ] [Question 1] - Owner: [Name]
176
+ - [ ] [Question 2] - Owner: [Name]
177
+
178
+ ---
179
+
180
+ ## Appendix
181
+ - [Link to research]
182
+ - [Link to competitive analysis]
183
+ - [Link to technical spike]
184
+ ```
185
+
186
+ ## User Story Standards
187
+
188
+ ### Format
189
+
190
+ ```gherkin
191
+ As a [persona/role],
192
+ I want to [action/goal],
193
+ So that [benefit/value].
194
+ ```
195
+
196
+ ### Acceptance Criteria Format
197
+
198
+ ```gherkin
199
+ Given [precondition/context],
200
+ When [action taken],
201
+ Then [expected result].
202
+ ```
203
+
204
+ ### INVEST Criteria
205
+
206
+ Good user stories are:
207
+
208
+ | Criteria | Description |
209
+ |----------|-------------|
210
+ | **I**ndependent | Can be developed separately |
211
+ | **N**egotiable | Details can be discussed |
212
+ | **V**aluable | Delivers value to user or business |
213
+ | **E**stimable | Can be sized by the team |
214
+ | **S**mall | Completable in one sprint |
215
+ | **T**estable | Has clear pass/fail criteria |
216
+
217
+ ### Story Examples
218
+
219
+ **Good Story:**
220
+ ```gherkin
221
+ As a sales manager,
222
+ I want to see my team's pipeline in a single dashboard,
223
+ So that I can identify deals at risk without checking each rep individually.
224
+
225
+ Acceptance Criteria:
226
+ - Given I am logged in as a sales manager
227
+ - When I navigate to the team dashboard
228
+ - Then I see all active deals for my team sorted by close date
229
+
230
+ - Given a deal has not been updated in 7+ days
231
+ - When I view the dashboard
232
+ - Then that deal is flagged with a warning indicator
233
+
234
+ - Given I click on a deal
235
+ - When the detail panel opens
236
+ - Then I see the full deal history without leaving the dashboard
237
+ ```
238
+
239
+ **Bad Story:**
240
+ ```gherkin
241
+ As a user,
242
+ I want a dashboard,
243
+ So that I can see things.
244
+
245
+ Acceptance Criteria:
246
+ - Dashboard works
247
+ - Shows data
248
+ ```
249
+
250
+ ### Story Sizing
251
+
252
+ | Size | Points | Characteristics |
253
+ |------|--------|-----------------|
254
+ | XS | 1 | Well-understood, < 1 day |
255
+ | S | 2 | Minimal unknowns, 1-2 days |
256
+ | M | 3 | Some complexity, 3-5 days |
257
+ | L | 5 | Multiple components, 1 week |
258
+ | XL | 8+ | Too large—split into smaller stories |
259
+
260
+ ### Splitting Large Stories
261
+
262
+ | Original Story | Split Stories |
263
+ |----------------|---------------|
264
+ | "As a user, I want to filter and sort the table" | 1. "Filter by status" 2. "Filter by date" 3. "Sort columns" |
265
+ | "As a user, I want to export reports" | 1. "Export to CSV" 2. "Export to PDF" 3. "Schedule exports" |
266
+
267
+ ## Edge Cases & Error States
268
+
269
+ ### Edge Case Documentation
270
+
271
+ ```markdown
272
+ ## Edge Cases: [Feature]
273
+
274
+ ### Empty States
275
+ - No data exists: [Behavior]
276
+ - Data loading: [Behavior]
277
+ - Filter returns no results: [Behavior]
278
+
279
+ ### Error States
280
+ - Network failure: [Behavior]
281
+ - Permission denied: [Behavior]
282
+ - Invalid input: [Behavior]
283
+ - Rate limited: [Behavior]
284
+
285
+ ### Boundary Conditions
286
+ - Maximum items: [Limit and behavior]
287
+ - Minimum values: [Behavior]
288
+ - Character limits: [Limits and validation]
289
+
290
+ ### Concurrent Access
291
+ - Multiple users editing: [Behavior]
292
+ - Stale data: [Behavior]
293
+ ```
294
+
295
+ ### Error Message Standards
296
+
297
+ | Element | Guideline |
298
+ |---------|-----------|
299
+ | Tone | Helpful, not blaming |
300
+ | Content | What happened + What to do |
301
+ | Action | Clear next step |
302
+
303
+ ```markdown
304
+ ❌ Bad: "Error 500"
305
+ ✅ Good: "We couldn't save your changes. Please try again, or contact support if this continues."
306
+
307
+ ❌ Bad: "Invalid input"
308
+ ✅ Good: "Email addresses must be in the format name@example.com"
309
+ ```
310
+
311
+ ## Requirements Review
312
+
313
+ ### Review Checklist
314
+
315
+ - [ ] Problem clearly stated with evidence
316
+ - [ ] Success metrics defined and measurable
317
+ - [ ] User stories meet INVEST criteria
318
+ - [ ] Acceptance criteria are testable
319
+ - [ ] Edge cases documented
320
+ - [ ] Dependencies identified
321
+ - [ ] Risks assessed with mitigations
322
+ - [ ] Timeline realistic with owner buy-in
323
+ - [ ] Open questions have owners
324
+ - [ ] Stakeholders have reviewed
325
+
326
+ ### Review Meeting Structure
327
+
328
+ ```markdown
329
+ ## PRD Review Agenda (60 min)
330
+
331
+ 1. **Context** (5 min)
332
+ - Problem recap
333
+ - Why now?
334
+
335
+ 2. **Walkthrough** (20 min)
336
+ - Solution overview
337
+ - Key user flows
338
+ - Technical approach
339
+
340
+ 3. **Discussion** (25 min)
341
+ - Open questions
342
+ - Concerns and risks
343
+ - Trade-off decisions
344
+
345
+ 4. **Alignment** (10 min)
346
+ - Confirm scope
347
+ - Agree on timeline
348
+ - Assign action items
349
+ ```
350
+
351
+ ## Version Control for Requirements
352
+
353
+ ### When to Create New Version
354
+
355
+ - Major scope change
356
+ - Significant timeline shift
357
+ - New stakeholder requirements
358
+
359
+ ### Version History
360
+
361
+ ```markdown
362
+ ## Changelog
363
+
364
+ ### v2.0 (2025-01-28)
365
+ - Added export functionality based on user feedback
366
+ - Removed scheduled reports (moved to Phase 2)
367
+ - Updated timeline to account for dependency delay
368
+
369
+ ### v1.0 (2025-01-15)
370
+ - Initial PRD
371
+ ```