@codihaus/claude-skills 1.6.21 → 1.6.22
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/package.json +1 -1
- package/skills/debrief/SKILL.md +89 -457
- package/skills/debrief/references/codes.md +135 -0
- package/skills/debrief/references/research.md +227 -0
- package/skills/debrief/references/templates/brd-references.md +80 -0
- package/skills/debrief/references/templates/feature-references.md +98 -0
- package/skills/debrief/references/templates/use-case.md +31 -0
- package/skills/debrief/references/workflow.md +315 -0
- package/skills/debrief/references/file-patterns.md +0 -173
- package/skills/debrief/references/group-codes.md +0 -72
- package/skills/debrief/references/research-queries.md +0 -106
- package/skills/debrief/references/use-case-template.md +0 -141
- /package/skills/debrief/references/{change-request-template.md → templates/change-request.md} +0 -0
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
# Workflow Principles
|
|
2
|
+
|
|
3
|
+
**Mindset**: Business analyst. Focus on WHAT and WHY, defer HOW to /dev-specs.
|
|
4
|
+
|
|
5
|
+
**Methodology**: Mode detection → Context gathering → Research → Document → Questionnaire
|
|
6
|
+
|
|
7
|
+
**Expected Outcome**: Market-validated BRD with tiered features, lean use cases, customer questionnaire.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Mode Detection
|
|
12
|
+
|
|
13
|
+
**Principle**: Behavior changes based on context.
|
|
14
|
+
|
|
15
|
+
**Detection**:
|
|
16
|
+
- `--answers {file}` → Process Answers mode
|
|
17
|
+
- `--questionnaire-only` → Questionnaire Only mode
|
|
18
|
+
- No `plans/brd/` → New Project mode
|
|
19
|
+
- `plans/brd/` exists → Add Feature mode
|
|
20
|
+
- Modifying confirmed UC → Change Request mode
|
|
21
|
+
|
|
22
|
+
**Action**: Execute appropriate workflow for detected mode.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## New Project Mode
|
|
27
|
+
|
|
28
|
+
**Goal**: Create initial BRD with market-validated features.
|
|
29
|
+
|
|
30
|
+
**Mindset**: Discovery mode. Understand context, research market, validate with customer.
|
|
31
|
+
|
|
32
|
+
### Context Gathering
|
|
33
|
+
|
|
34
|
+
**Ask 5 questions** (AskUserQuestion):
|
|
35
|
+
1. Project type (new/existing codebase)
|
|
36
|
+
2. Industry (SaaS/E-commerce/Marketplace/etc.)
|
|
37
|
+
3. Target users (B2B/B2C/Internal)
|
|
38
|
+
4. Constraints (timeline/budget/compliance/integrations)
|
|
39
|
+
5. Scope tier (Core/Standard/Full)
|
|
40
|
+
|
|
41
|
+
**If existing codebase**: Scan for docs + features (Glob, Read)
|
|
42
|
+
|
|
43
|
+
**Output**: Context understanding, scope alignment
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
### Market Research
|
|
48
|
+
|
|
49
|
+
**Methodology**: See `research.md` for full process.
|
|
50
|
+
|
|
51
|
+
**Comparison-first**:
|
|
52
|
+
- Find 2-3 comparison/alternative pages
|
|
53
|
+
- Extract feature matrix
|
|
54
|
+
- Initial tier hypothesis
|
|
55
|
+
|
|
56
|
+
**Deep validation**:
|
|
57
|
+
- Per feature: cross-validate with ecosystem + user signals
|
|
58
|
+
- Classify tier (MVP/Standard/Advanced)
|
|
59
|
+
- Collect evidence
|
|
60
|
+
|
|
61
|
+
**Output**: Features with tier classification and evidence
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
### Feature Sequencing
|
|
66
|
+
|
|
67
|
+
**Principle**: Order by dependencies within each tier.
|
|
68
|
+
|
|
69
|
+
**Common patterns**:
|
|
70
|
+
- Create before operate (signup before login)
|
|
71
|
+
- Auth before features (login before projects)
|
|
72
|
+
- Basic before advanced (CRUD before bulk operations)
|
|
73
|
+
- Data before analytics (tracking before dashboards)
|
|
74
|
+
- Core before extensions (email before templates)
|
|
75
|
+
|
|
76
|
+
**Validation**: No forward dependencies (UC-001 doesn't depend on UC-002)
|
|
77
|
+
|
|
78
|
+
**Output**: Sequenced feature list (UC-001, UC-002, UC-003...)
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
### Use Case Generation
|
|
83
|
+
|
|
84
|
+
**Principle**: Lean 80/20 format (~30 lines).
|
|
85
|
+
|
|
86
|
+
**Include (20%)**:
|
|
87
|
+
- Story (1 line)
|
|
88
|
+
- Critical acceptance criteria (3-5 bullets)
|
|
89
|
+
- Key business rules (constraints, limits)
|
|
90
|
+
- Open questions (blockers)
|
|
91
|
+
|
|
92
|
+
**Defer to /dev-specs (80%)**:
|
|
93
|
+
- Detailed flows, integrations, edge cases, UI/UX
|
|
94
|
+
|
|
95
|
+
**Template**: `templates/use-case.md`
|
|
96
|
+
|
|
97
|
+
**Output**: Lean use cases in `brd/use-cases/{feature}/UC-{GROUP}-{NNN}-{slug}.md`
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
### BRD Structure
|
|
102
|
+
|
|
103
|
+
**Project-wide** (`brd/`):
|
|
104
|
+
- README.md (all features index)
|
|
105
|
+
- context.md (stakeholders, users, constraints)
|
|
106
|
+
- references.md (industry, compliance, competitor overview)
|
|
107
|
+
- changelog.md
|
|
108
|
+
|
|
109
|
+
**Feature-specific** (`features/{feature}/`):
|
|
110
|
+
- README.md (feature overview)
|
|
111
|
+
- references.md (market research, tier evidence)
|
|
112
|
+
- questionnaire-{date}.xlsx
|
|
113
|
+
|
|
114
|
+
**Templates**: `templates/brd-references.md`, `templates/feature-references.md`
|
|
115
|
+
|
|
116
|
+
**Output**: Organized BRD structure with scope separation
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
### Questionnaire
|
|
121
|
+
|
|
122
|
+
**Principle**: Always generate. Validate assumptions + fill gaps.
|
|
123
|
+
|
|
124
|
+
**Include**:
|
|
125
|
+
- **Validation questions**: "We found 9/10 competitors offer SSO. Confirm?"
|
|
126
|
+
- **Open questions**: "What's max team size per account?"
|
|
127
|
+
|
|
128
|
+
**Categories**: Validation, Business, Requirements, Constraints, Integration
|
|
129
|
+
|
|
130
|
+
**Output**: `features/{feature}/questionnaire-{date}.xlsx`
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
### Summary
|
|
135
|
+
|
|
136
|
+
**Provide**:
|
|
137
|
+
- Files created (brd/, features/)
|
|
138
|
+
- Use case count (lean format)
|
|
139
|
+
- Research summary (comparison pages, evidence sources)
|
|
140
|
+
- Tier distribution (MVP: X, Standard: Y, Advanced: Z)
|
|
141
|
+
- Questionnaire location and question count
|
|
142
|
+
|
|
143
|
+
**Next steps**:
|
|
144
|
+
- Review BRD with stakeholders
|
|
145
|
+
- Send questionnaire to customer
|
|
146
|
+
- Process with `/debrief --answers {path}`
|
|
147
|
+
- Then `/dev-specs {feature}` for implementation
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## Add Feature Mode
|
|
152
|
+
|
|
153
|
+
**Goal**: Extend existing BRD with new feature.
|
|
154
|
+
|
|
155
|
+
**Mindset**: Continuity mode. Check duplicates, maintain consistency.
|
|
156
|
+
|
|
157
|
+
### Context Gathering
|
|
158
|
+
|
|
159
|
+
**Ask 2 questions**:
|
|
160
|
+
1. Feature name
|
|
161
|
+
2. Scope tier (Core/Standard/Full)
|
|
162
|
+
|
|
163
|
+
**Duplicate check**: Read `docs-graph.json` if exists, warn if similar feature found
|
|
164
|
+
|
|
165
|
+
**Output**: Feature to add, scope confirmed
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
### Research & Document
|
|
170
|
+
|
|
171
|
+
**Same as New Project**:
|
|
172
|
+
- Market research (comparison-first, see `research.md`)
|
|
173
|
+
- Feature sequencing (dependencies)
|
|
174
|
+
- Lean use cases (templates/use-case.md)
|
|
175
|
+
|
|
176
|
+
**Update**:
|
|
177
|
+
- `brd/README.md` (add to index)
|
|
178
|
+
- `brd/changelog.md` (log addition)
|
|
179
|
+
- Create `features/{feature}/` folder
|
|
180
|
+
|
|
181
|
+
**Questionnaire**: Always generate (validation + open questions)
|
|
182
|
+
|
|
183
|
+
**Output**: Feature added to BRD with research and questionnaire
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Process Answers Mode
|
|
188
|
+
|
|
189
|
+
**Goal**: Update BRD with customer responses.
|
|
190
|
+
|
|
191
|
+
**Mindset**: Integration mode. Incorporate feedback, resolve gaps.
|
|
192
|
+
|
|
193
|
+
### Process
|
|
194
|
+
|
|
195
|
+
**Read questionnaire** (Excel file):
|
|
196
|
+
- Extract answers from "Answer" column
|
|
197
|
+
- Match to source use cases via "Context/Source"
|
|
198
|
+
|
|
199
|
+
**Update use cases**:
|
|
200
|
+
- Remove questions from "Open Questions" section
|
|
201
|
+
- Add answers to relevant sections (Acceptance Criteria, Business Rules)
|
|
202
|
+
|
|
203
|
+
**Update feature README**:
|
|
204
|
+
- Log questionnaire as processed
|
|
205
|
+
- Track history
|
|
206
|
+
|
|
207
|
+
**Check completeness**:
|
|
208
|
+
- If gaps remain → generate new questionnaire (new date)
|
|
209
|
+
- If complete → update UC status to "Confirmed"
|
|
210
|
+
|
|
211
|
+
**Output**: Updated use cases, questionnaire history, completion status
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
|
|
215
|
+
## Change Request Mode
|
|
216
|
+
|
|
217
|
+
**Goal**: Track modifications to confirmed BRD.
|
|
218
|
+
|
|
219
|
+
**Mindset**: Traceability mode. Document change rationale and impact.
|
|
220
|
+
|
|
221
|
+
### Process
|
|
222
|
+
|
|
223
|
+
**Create CR** (`brd/changes/CR-{NNN}-{slug}.md`):
|
|
224
|
+
- Change description
|
|
225
|
+
- Reason for change
|
|
226
|
+
- Impact analysis (affected UCs)
|
|
227
|
+
|
|
228
|
+
**If gaps introduced**: Generate questionnaire at `brd/changes/CR-{NNN}-questionnaire-{date}.xlsx`
|
|
229
|
+
|
|
230
|
+
**Update**: Affected use cases, references, changelog
|
|
231
|
+
|
|
232
|
+
**Output**: CR document with impact analysis
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
## Questionnaire Only Mode
|
|
237
|
+
|
|
238
|
+
**Goal**: Generate questions without creating BRD.
|
|
239
|
+
|
|
240
|
+
**Mindset**: Quick mode. Capture questions for customer.
|
|
241
|
+
|
|
242
|
+
### Process
|
|
243
|
+
|
|
244
|
+
**Ask**:
|
|
245
|
+
- Topic/feature name
|
|
246
|
+
- Custom questions (user provides)
|
|
247
|
+
|
|
248
|
+
**Generate**: `questionnaire-{date}.xlsx` in current directory
|
|
249
|
+
|
|
250
|
+
**Output**: Excel file ready to send
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
## File Organization Principles
|
|
255
|
+
|
|
256
|
+
**Scope-based placement**:
|
|
257
|
+
|
|
258
|
+
**Project-wide** (applies to entire product):
|
|
259
|
+
- Industry landscape → `brd/references.md`
|
|
260
|
+
- Compliance (GDPR, PCI) → `brd/references.md`
|
|
261
|
+
- Competitor companies → `brd/references.md`
|
|
262
|
+
- Use cases → `brd/use-cases/{feature}/`
|
|
263
|
+
|
|
264
|
+
**Feature-specific** (applies to one feature):
|
|
265
|
+
- Market research → `features/{feature}/references.md`
|
|
266
|
+
- Tier evidence → `features/{feature}/references.md`
|
|
267
|
+
- Questionnaire → `features/{feature}/questionnaire-{date}.xlsx`
|
|
268
|
+
|
|
269
|
+
**Cross-reference**: Files can link to each other
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
## Use Case Principles
|
|
274
|
+
|
|
275
|
+
**Lean format** (80/20 rule):
|
|
276
|
+
- ~30 lines max
|
|
277
|
+
- Scannable in 30 seconds
|
|
278
|
+
- Business focus only (no technical details)
|
|
279
|
+
|
|
280
|
+
**Sequencing**:
|
|
281
|
+
- Dependencies first (create before validate)
|
|
282
|
+
- Logical user journey
|
|
283
|
+
- No forward references
|
|
284
|
+
|
|
285
|
+
**Wikilinks**: Use [[node-id]] for docs-graph traceability
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
|
|
289
|
+
## Research Principles
|
|
290
|
+
|
|
291
|
+
**See**: `research.md` for full methodology.
|
|
292
|
+
|
|
293
|
+
**Key principles**:
|
|
294
|
+
- Comparison-first (fast feature extraction)
|
|
295
|
+
- Evidence-based (multiple source types)
|
|
296
|
+
- Tier validation (MVP/Standard/Advanced rules)
|
|
297
|
+
- Always questionnaire (validation + open questions)
|
|
298
|
+
|
|
299
|
+
---
|
|
300
|
+
|
|
301
|
+
## Summary
|
|
302
|
+
|
|
303
|
+
**Workflow adapts to mode**:
|
|
304
|
+
- New Project: Full discovery and research
|
|
305
|
+
- Add Feature: Focused research, duplicate check
|
|
306
|
+
- Process Answers: Integration and validation
|
|
307
|
+
- Change Request: Impact tracking
|
|
308
|
+
- Questionnaire Only: Quick question generation
|
|
309
|
+
|
|
310
|
+
**Consistent principles**:
|
|
311
|
+
- Business focus (WHAT and WHY)
|
|
312
|
+
- Evidence-based validation
|
|
313
|
+
- Lean documentation (80/20)
|
|
314
|
+
- Scope-based organization
|
|
315
|
+
- Customer validation (questionnaire)
|
|
@@ -1,173 +0,0 @@
|
|
|
1
|
-
# File Patterns for Codebase Discovery
|
|
2
|
-
|
|
3
|
-
Patterns for lightweight scanning of existing codebases.
|
|
4
|
-
|
|
5
|
-
## Frontend File Patterns
|
|
6
|
-
|
|
7
|
-
### Include
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
# Vue.js
|
|
11
|
-
**/*.vue
|
|
12
|
-
|
|
13
|
-
# React / Next.js
|
|
14
|
-
**/*.tsx
|
|
15
|
-
**/*.jsx
|
|
16
|
-
**/pages/**/*.ts
|
|
17
|
-
**/pages/**/*.tsx
|
|
18
|
-
**/app/**/page.tsx
|
|
19
|
-
**/app/**/layout.tsx
|
|
20
|
-
|
|
21
|
-
# Svelte
|
|
22
|
-
**/*.svelte
|
|
23
|
-
|
|
24
|
-
# Angular
|
|
25
|
-
**/*.component.ts
|
|
26
|
-
|
|
27
|
-
# General
|
|
28
|
-
**/views/**/*
|
|
29
|
-
**/screens/**/*
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### Exclude
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
# Dependencies
|
|
36
|
-
node_modules/**
|
|
37
|
-
vendor/**
|
|
38
|
-
bower_components/**
|
|
39
|
-
|
|
40
|
-
# Build output
|
|
41
|
-
dist/**
|
|
42
|
-
build/**
|
|
43
|
-
.next/**
|
|
44
|
-
.nuxt/**
|
|
45
|
-
.output/**
|
|
46
|
-
out/**
|
|
47
|
-
|
|
48
|
-
# Bundled files
|
|
49
|
-
*.min.js
|
|
50
|
-
*.bundle.js
|
|
51
|
-
*.chunk.js
|
|
52
|
-
|
|
53
|
-
# Tests
|
|
54
|
-
__tests__/**
|
|
55
|
-
**/*.test.*
|
|
56
|
-
**/*.spec.*
|
|
57
|
-
**/test/**
|
|
58
|
-
**/tests/**
|
|
59
|
-
|
|
60
|
-
# Config & misc
|
|
61
|
-
.git/**
|
|
62
|
-
coverage/**
|
|
63
|
-
.cache/**
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
## Documentation Patterns
|
|
67
|
-
|
|
68
|
-
Look for existing docs:
|
|
69
|
-
|
|
70
|
-
```
|
|
71
|
-
# Root docs
|
|
72
|
-
README.md
|
|
73
|
-
CLAUDE.md
|
|
74
|
-
CONTRIBUTING.md
|
|
75
|
-
|
|
76
|
-
# Doc folders
|
|
77
|
-
docs/**/*.md
|
|
78
|
-
documentation/**/*.md
|
|
79
|
-
plans/**/*.md
|
|
80
|
-
specifications/**/*.md
|
|
81
|
-
specs/**/*.md
|
|
82
|
-
.github/**/*.md
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
## Feature Inference
|
|
86
|
-
|
|
87
|
-
Map file/folder names to features:
|
|
88
|
-
|
|
89
|
-
| Pattern | Feature |
|
|
90
|
-
|---------|---------|
|
|
91
|
-
| `auth/`, `login.*`, `signin.*`, `signup.*` | Authentication |
|
|
92
|
-
| `user/`, `users/`, `profile.*`, `account.*` | User Management |
|
|
93
|
-
| `dashboard.*`, `dashboard/` | Dashboard |
|
|
94
|
-
| `payment/`, `payments/`, `checkout.*`, `billing.*` | Payments |
|
|
95
|
-
| `subscription/`, `subscriptions/`, `plans.*` | Subscriptions |
|
|
96
|
-
| `settings.*`, `settings/`, `preferences.*` | Settings |
|
|
97
|
-
| `admin/`, `admin.*` | Admin Panel |
|
|
98
|
-
| `notification/`, `notifications/`, `alerts/` | Notifications |
|
|
99
|
-
| `search.*`, `search/` | Search |
|
|
100
|
-
| `cart.*`, `cart/`, `basket.*` | Shopping Cart |
|
|
101
|
-
| `order/`, `orders/` | Orders |
|
|
102
|
-
| `product/`, `products/`, `catalog/` | Products |
|
|
103
|
-
| `message/`, `messages/`, `chat/`, `inbox/` | Messaging |
|
|
104
|
-
| `report/`, `reports/`, `analytics/` | Reporting |
|
|
105
|
-
| `upload/`, `files/`, `media/` | File Management |
|
|
106
|
-
| `team/`, `teams/`, `organization/` | Team Management |
|
|
107
|
-
| `onboarding/`, `wizard/`, `setup/` | Onboarding |
|
|
108
|
-
| `help/`, `support/`, `faq/` | Help/Support |
|
|
109
|
-
|
|
110
|
-
## Tech Stack Detection
|
|
111
|
-
|
|
112
|
-
### Package Managers
|
|
113
|
-
|
|
114
|
-
```
|
|
115
|
-
# Check for these files
|
|
116
|
-
package.json → Node.js / JavaScript
|
|
117
|
-
requirements.txt → Python
|
|
118
|
-
Gemfile → Ruby
|
|
119
|
-
go.mod → Go
|
|
120
|
-
Cargo.toml → Rust
|
|
121
|
-
composer.json → PHP
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Framework Detection (from package.json)
|
|
125
|
-
|
|
126
|
-
| Dependency | Framework |
|
|
127
|
-
|------------|-----------|
|
|
128
|
-
| `next` | Next.js |
|
|
129
|
-
| `nuxt` | Nuxt.js |
|
|
130
|
-
| `vue` | Vue.js |
|
|
131
|
-
| `react` | React |
|
|
132
|
-
| `@angular/core` | Angular |
|
|
133
|
-
| `svelte` | Svelte |
|
|
134
|
-
| `express` | Express.js |
|
|
135
|
-
| `fastify` | Fastify |
|
|
136
|
-
| `nestjs` | NestJS |
|
|
137
|
-
|
|
138
|
-
## Folder Structure Hints
|
|
139
|
-
|
|
140
|
-
```
|
|
141
|
-
# Next.js App Router
|
|
142
|
-
app/
|
|
143
|
-
├── page.tsx → Home page
|
|
144
|
-
├── layout.tsx → Root layout
|
|
145
|
-
├── (auth)/ → Auth group
|
|
146
|
-
│ ├── login/
|
|
147
|
-
│ └── register/
|
|
148
|
-
└── dashboard/ → Dashboard
|
|
149
|
-
|
|
150
|
-
# Nuxt.js
|
|
151
|
-
pages/
|
|
152
|
-
├── index.vue → Home
|
|
153
|
-
├── login.vue → Login
|
|
154
|
-
└── dashboard/
|
|
155
|
-
└── index.vue → Dashboard
|
|
156
|
-
|
|
157
|
-
# Standard React
|
|
158
|
-
src/
|
|
159
|
-
├── pages/ → Routes
|
|
160
|
-
├── components/ → UI components
|
|
161
|
-
├── hooks/ → Custom hooks
|
|
162
|
-
├── services/ → API calls
|
|
163
|
-
└── utils/ → Helpers
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
## Scan Strategy
|
|
167
|
-
|
|
168
|
-
1. **Find package.json** → Detect framework
|
|
169
|
-
2. **Glob for frontend files** → List all pages/components
|
|
170
|
-
3. **Group by folder** → pages/, components/, views/
|
|
171
|
-
4. **Match patterns** → Infer features
|
|
172
|
-
5. **Check for docs** → Read README, CLAUDE.md
|
|
173
|
-
6. **Summarize** → Create feature table
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
# Use Case Group Codes
|
|
2
|
-
|
|
3
|
-
Standard codes for grouping use cases. Use these for consistency across BRDs.
|
|
4
|
-
|
|
5
|
-
## Standard Codes
|
|
6
|
-
|
|
7
|
-
| Code | Domain | Examples |
|
|
8
|
-
|------|--------|----------|
|
|
9
|
-
| **AUTH** | Authentication | Login, logout, password reset, SSO |
|
|
10
|
-
| **USER** | User Management | Registration, profile, settings |
|
|
11
|
-
| **PAY** | Payments | Checkout, refunds, payment methods |
|
|
12
|
-
| **SUB** | Subscriptions | Plans, upgrades, cancellation |
|
|
13
|
-
| **BILL** | Billing | Invoices, receipts, statements |
|
|
14
|
-
| **NOTIF** | Notifications | Email, push, in-app alerts |
|
|
15
|
-
| **ADMIN** | Administration | Dashboard, settings, config |
|
|
16
|
-
| **RPT** | Reporting | Analytics, exports, dashboards |
|
|
17
|
-
| **INTG** | Integrations | API, webhooks, third-party |
|
|
18
|
-
| **SRCH** | Search | Search, filters, browse |
|
|
19
|
-
| **INV** | Inventory | Stock, catalog, products |
|
|
20
|
-
| **ORD** | Orders | Cart, checkout, order history |
|
|
21
|
-
| **SHIP** | Shipping | Delivery, tracking, returns |
|
|
22
|
-
| **MSG** | Messaging | Chat, comments, threads |
|
|
23
|
-
| **FILE** | Files | Upload, storage, sharing |
|
|
24
|
-
| **TEAM** | Teams | Organizations, roles, permissions |
|
|
25
|
-
| **ONBD** | Onboarding | Setup, tutorials, first-run |
|
|
26
|
-
| **SUPP** | Support | Help, tickets, FAQ |
|
|
27
|
-
|
|
28
|
-
## Choosing Codes
|
|
29
|
-
|
|
30
|
-
1. **Use existing code** if it fits
|
|
31
|
-
2. **Create new code** if domain is distinct
|
|
32
|
-
3. **Keep codes 3-5 characters**
|
|
33
|
-
4. **Make it obvious** - anyone should guess the domain
|
|
34
|
-
|
|
35
|
-
## Custom Codes
|
|
36
|
-
|
|
37
|
-
For project-specific domains, define in BRD README:
|
|
38
|
-
|
|
39
|
-
```markdown
|
|
40
|
-
## Custom Group Codes
|
|
41
|
-
|
|
42
|
-
| Code | Domain | Description |
|
|
43
|
-
|------|--------|-------------|
|
|
44
|
-
| PROP | Properties | Real estate listings |
|
|
45
|
-
| BOOK | Bookings | Reservation system |
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Grouping Strategy
|
|
49
|
-
|
|
50
|
-
**Group by user intent**, not by feature:
|
|
51
|
-
|
|
52
|
-
Good:
|
|
53
|
-
- `UC-PAY-001-checkout.md` - User paying
|
|
54
|
-
- `UC-PAY-002-refund-request.md` - User requesting money back
|
|
55
|
-
|
|
56
|
-
Avoid:
|
|
57
|
-
- `UC-STRIPE-001-...` - Implementation detail, not user intent
|
|
58
|
-
- `UC-BUTTON-001-...` - UI element, not user goal
|
|
59
|
-
|
|
60
|
-
## Cross-Group Dependencies
|
|
61
|
-
|
|
62
|
-
Note dependencies in use case files:
|
|
63
|
-
|
|
64
|
-
```markdown
|
|
65
|
-
> **Related**: [UC-AUTH-001](./UC-AUTH-001-login.md), [UC-PAY-001](./UC-PAY-001-checkout.md)
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Common patterns:
|
|
69
|
-
- AUTH → all authenticated features
|
|
70
|
-
- USER → TEAM (user creates team)
|
|
71
|
-
- PAY → SUB (payment enables subscription)
|
|
72
|
-
- ORD → SHIP (order triggers shipping)
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
# Research Query Templates
|
|
2
|
-
|
|
3
|
-
Use these to gather **references for engineers**, not to prescribe solutions.
|
|
4
|
-
|
|
5
|
-
## Goal
|
|
6
|
-
|
|
7
|
-
Populate `references.md` with:
|
|
8
|
-
- Official documentation links
|
|
9
|
-
- Industry examples
|
|
10
|
-
- Implementation case studies
|
|
11
|
-
- Compliance/standards resources
|
|
12
|
-
|
|
13
|
-
## Query Templates
|
|
14
|
-
|
|
15
|
-
### Documentation
|
|
16
|
-
```
|
|
17
|
-
"{feature} official documentation"
|
|
18
|
-
"{service} API documentation"
|
|
19
|
-
"{feature} developer guide"
|
|
20
|
-
"{service} SDK documentation"
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
### Industry Examples
|
|
24
|
-
```
|
|
25
|
-
"how {company} implements {feature}"
|
|
26
|
-
"{feature} case study"
|
|
27
|
-
"{industry} {feature} examples"
|
|
28
|
-
"best {feature} implementations"
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### User Flows
|
|
32
|
-
```
|
|
33
|
-
"{feature} user flow examples"
|
|
34
|
-
"{feature} UX patterns"
|
|
35
|
-
"{feature} wireframe examples"
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Compliance & Standards
|
|
39
|
-
```
|
|
40
|
-
"{feature} {regulation} compliance"
|
|
41
|
-
"{feature} security requirements"
|
|
42
|
-
"{industry} {feature} standards"
|
|
43
|
-
"GDPR {feature} requirements"
|
|
44
|
-
"PCI DSS {feature}"
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
### Open Source / Tutorials
|
|
48
|
-
```
|
|
49
|
-
"{feature} open source implementation"
|
|
50
|
-
"{feature} tutorial github"
|
|
51
|
-
"building {feature} from scratch"
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
## By Domain
|
|
55
|
-
|
|
56
|
-
### SaaS / B2B
|
|
57
|
-
```
|
|
58
|
-
"enterprise {feature} requirements"
|
|
59
|
-
"B2B SaaS {feature} examples"
|
|
60
|
-
"{feature} multi-tenant considerations"
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
### E-commerce
|
|
64
|
-
```
|
|
65
|
-
"{feature} e-commerce best practices"
|
|
66
|
-
"shopify {feature} documentation"
|
|
67
|
-
"stripe {feature} guide"
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### Marketplace
|
|
71
|
-
```
|
|
72
|
-
"two-sided marketplace {feature}"
|
|
73
|
-
"platform {feature} patterns"
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
## Search Strategy
|
|
77
|
-
|
|
78
|
-
1. **Start broad**: "{feature} documentation"
|
|
79
|
-
2. **Get specific**: "{service} {feature} API"
|
|
80
|
-
3. **Find examples**: "how {leader} does {feature}"
|
|
81
|
-
4. **Check compliance**: "{feature} {regulation}"
|
|
82
|
-
5. **Gather tutorials**: "{feature} implementation guide"
|
|
83
|
-
|
|
84
|
-
## What to Capture
|
|
85
|
-
|
|
86
|
-
For each useful result, note:
|
|
87
|
-
- **Title**: Page/article title
|
|
88
|
-
- **URL**: Direct link
|
|
89
|
-
- **Why relevant**: 1-line note for engineers
|
|
90
|
-
- **Applies to**: Which use cases benefit
|
|
91
|
-
|
|
92
|
-
## Example Output
|
|
93
|
-
|
|
94
|
-
```markdown
|
|
95
|
-
## Documentation
|
|
96
|
-
| Topic | Link | Notes |
|
|
97
|
-
|-------|------|-------|
|
|
98
|
-
| Stripe Billing | [Stripe Subscriptions](https://stripe.com/docs/billing) | Core billing API |
|
|
99
|
-
| Usage metering | [Stripe Usage Records](https://stripe.com/docs/billing/subscriptions/usage-based) | For usage-based billing |
|
|
100
|
-
|
|
101
|
-
## Industry Examples
|
|
102
|
-
| Company | Link | What to Learn |
|
|
103
|
-
|---------|------|---------------|
|
|
104
|
-
| Notion | [How Notion Prices](https://www.notion.so/pricing) | Freemium + team pricing |
|
|
105
|
-
| Slack | [Slack Billing](https://slack.com/pricing) | Per-seat model |
|
|
106
|
-
```
|