sdlc-workflow 1.0.0 → 1.0.1
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 +13 -4
- package/bin/cli.js +85 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,9 +5,13 @@ Scaffold SDLC workflow docs and templates into your project. Works with **Cursor
|
|
|
5
5
|
## Flow
|
|
6
6
|
|
|
7
7
|
```
|
|
8
|
-
User Request → PO → Business BA → Architect → Technical BA →
|
|
8
|
+
User Request → PO → Business BA → Architect → Technical BA → QE (docs) → Dev → QE (testing) → Deploy
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
- **QE (docs)**: Test plan, test cases — before Dev implements
|
|
12
|
+
- **Dev**: Tech Lead (review, merge) + Senior Dev (implement, Unit Test ≥90%)
|
|
13
|
+
- **QE (testing)**: After Dev unit tests — automation + manual, sign-off
|
|
14
|
+
|
|
11
15
|
## Usage
|
|
12
16
|
|
|
13
17
|
In your project directory:
|
|
@@ -43,9 +47,14 @@ docs/sdlc/
|
|
|
43
47
|
├── architecture/ # Architect
|
|
44
48
|
│ ├── adr.template.md
|
|
45
49
|
│ └── README.md
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
50
|
+
├── qe/ # QE (docs + testing)
|
|
51
|
+
│ ├── test-case.template.md
|
|
52
|
+
│ └── README.md
|
|
53
|
+
└── dev/ # Dev team (per role)
|
|
54
|
+
├── tech-lead/ # Tech Lead 15+ yrs: tech stack, review & merge
|
|
55
|
+
│ └── README.md
|
|
56
|
+
└── senior-developer/ # Senior Dev 10+ yrs: implement, Unit Test ≥90%
|
|
57
|
+
└── README.md
|
|
49
58
|
|
|
50
59
|
.cursor/rules/
|
|
51
60
|
└── sdlc-workflow.mdc # Cursor rule
|
package/bin/cli.js
CHANGED
|
@@ -95,6 +95,8 @@ async function generateFromInline(cwd) {
|
|
|
95
95
|
join(base, "ba", "technical"),
|
|
96
96
|
join(base, "architecture"),
|
|
97
97
|
join(base, "qe"),
|
|
98
|
+
join(base, "dev", "tech-lead"),
|
|
99
|
+
join(base, "dev", "senior-developer"),
|
|
98
100
|
];
|
|
99
101
|
|
|
100
102
|
for (const d of dirs) {
|
|
@@ -115,6 +117,8 @@ async function generateFromInline(cwd) {
|
|
|
115
117
|
["architecture/README.md", ARCH_README],
|
|
116
118
|
["qe/test-case.template.md", QE_TC_TEMPLATE],
|
|
117
119
|
["qe/README.md", QE_README],
|
|
120
|
+
["dev/tech-lead/README.md", DEV_TECH_LEAD_README],
|
|
121
|
+
["dev/senior-developer/README.md", DEV_SENIOR_README],
|
|
118
122
|
];
|
|
119
123
|
|
|
120
124
|
for (const [rel, content] of files) {
|
|
@@ -125,21 +129,21 @@ async function generateFromInline(cwd) {
|
|
|
125
129
|
}
|
|
126
130
|
|
|
127
131
|
const CURSOR_RULE_CONTENT = `---
|
|
128
|
-
description: SDLC multi-role workflow (PO → BA → Architect → Tech BA → Dev → QE)
|
|
132
|
+
description: SDLC multi-role workflow (PO → BA → Architect → Tech BA → QE docs → Dev → QE testing)
|
|
129
133
|
alwaysApply: false
|
|
130
134
|
globs: docs/sdlc/**/*, **/*.md
|
|
131
135
|
---
|
|
132
136
|
|
|
133
137
|
# SDLC Workflow
|
|
134
138
|
|
|
135
|
-
When working on requirements or docs, follow the SDLC phases:
|
|
136
|
-
|
|
137
139
|
1. **PO** — PRD, user stories → docs/sdlc/po/
|
|
138
140
|
2. **Business BA** — FRS, process flows → docs/sdlc/ba/business/
|
|
139
141
|
3. **Architect** — ADRs, diagrams → docs/sdlc/architecture/
|
|
140
142
|
4. **Technical BA** — API specs, team breakdown → docs/sdlc/ba/technical/
|
|
141
|
-
5. **
|
|
142
|
-
6. **
|
|
143
|
+
5. **QE (docs)** — Test plan, test cases → docs/sdlc/qe/
|
|
144
|
+
6. **Dev** — Tech Lead (review, merge) + Senior Dev (implement, ≥90% unit test) → docs/sdlc/dev/{role}/
|
|
145
|
+
7. **QE (testing)** — Automation + manual tests, sign-off
|
|
146
|
+
8. **Deploy** — Release, monitor
|
|
143
147
|
|
|
144
148
|
Full workflow: docs/sdlc/SDLC-WORKFLOW.md
|
|
145
149
|
`;
|
|
@@ -156,7 +160,7 @@ Sequential workflow for approaching user requirements. Each phase produces docs/
|
|
|
156
160
|
## Flow Overview
|
|
157
161
|
|
|
158
162
|
\`\`\`
|
|
159
|
-
User Request → PO → Business BA → Architect → Technical BA →
|
|
163
|
+
User Request → PO → Business BA → Architect → Technical BA → QE (docs) → Dev → QE (testing) → Deploy
|
|
160
164
|
\`\`\`
|
|
161
165
|
|
|
162
166
|
**Determine current phase** before acting. If unsure, ask: "Which phase are we in?"
|
|
@@ -190,17 +194,30 @@ User Request → PO → Business BA → Architect → Technical BA → Dev Teams
|
|
|
190
194
|
|
|
191
195
|
**Role**: Translate business + architecture into implementable specs.
|
|
192
196
|
**Deliverables**: API specs, DB schema, team breakdown, acceptance criteria per ticket.
|
|
193
|
-
**Output**: \`docs/sdlc/ba/technical/\` — **Handoff to Dev
|
|
197
|
+
**Output**: \`docs/sdlc/ba/technical/\` — **Handoff to QE + Dev.**
|
|
198
|
+
|
|
199
|
+
## Phase 5a: QE (Docs phase)
|
|
200
|
+
|
|
201
|
+
**Role**: Create test plan, test cases before Dev implements.
|
|
202
|
+
**Deliverables**: Test plan, test cases.
|
|
203
|
+
**Output**: \`docs/sdlc/qe/\` — Ready for Dev to start implementation.
|
|
204
|
+
|
|
205
|
+
## Phase 5b: Dev Teams
|
|
206
|
+
|
|
207
|
+
**Trigger**: After QE docs complete. **Start implementation.**
|
|
208
|
+
|
|
209
|
+
**Roles**:
|
|
210
|
+
- **Tech Lead (15+ yrs)**: Decide tech stack, libraries; review & merge code. Docs: \`docs/sdlc/dev/tech-lead/\`
|
|
211
|
+
- **Senior Developer (10+ yrs)**: Implement features per spec. Docs: \`docs/sdlc/dev/senior-developer/\`
|
|
194
212
|
|
|
195
|
-
|
|
213
|
+
**Requirements**: Unit Test coverage **≥ 90%**.
|
|
196
214
|
|
|
197
|
-
**
|
|
198
|
-
**Output**: Code + tests. **Handoff to QE.**
|
|
215
|
+
**Output**: Code + unit tests. **Handoff to QE (testing).**
|
|
199
216
|
|
|
200
|
-
## Phase 6: QE (
|
|
217
|
+
## Phase 6: QE (Testing phase)
|
|
201
218
|
|
|
202
|
-
**
|
|
203
|
-
**
|
|
219
|
+
**Trigger**: After Dev completes unit tests.
|
|
220
|
+
**Role**: Run tests, include **automation tests**, sign-off.
|
|
204
221
|
**Output**: Test report. **Handoff to Deploy.**
|
|
205
222
|
|
|
206
223
|
## Phase 7: Deploy & Maintenance
|
|
@@ -216,8 +233,9 @@ User Request → PO → Business BA → Architect → Technical BA → Dev Teams
|
|
|
216
233
|
| 2 | Business BA | FRS, process flows |
|
|
217
234
|
| 3 | Architect | ADRs, system diagrams |
|
|
218
235
|
| 4 | Technical BA | API specs, tech breakdown |
|
|
219
|
-
|
|
|
220
|
-
|
|
|
236
|
+
| 5a | QE (docs) | Test plan, test cases |
|
|
237
|
+
| 5b | Dev | Code, unit tests (≥90%) |
|
|
238
|
+
| 6 | QE (testing) | Automation + manual, sign-off |
|
|
221
239
|
| 7 | Ops | Deploy, monitor |
|
|
222
240
|
|
|
223
241
|
See reference.md for templates.
|
|
@@ -240,21 +258,24 @@ POST /api/v1/[resource] — Purpose, Request, Response, Contract
|
|
|
240
258
|
|
|
241
259
|
## QE: Test Case
|
|
242
260
|
TC-001: [Scenario] — Precondition, Steps, Expected, Links to AC
|
|
261
|
+
|
|
262
|
+
## Dev Team
|
|
263
|
+
- Tech Lead (15+ yrs): tech stack, libraries, review & merge → docs/sdlc/dev/tech-lead/
|
|
264
|
+
- Senior Dev (10+ yrs): implement, Unit Test ≥90% → docs/sdlc/dev/senior-developer/
|
|
243
265
|
`;
|
|
244
266
|
|
|
245
267
|
const CLAUDE_SDLC_CONTENT = `## SDLC Workflow
|
|
246
268
|
|
|
247
|
-
When working on requirements, features, or handoffs, follow these phases:
|
|
248
|
-
|
|
249
269
|
1. **PO** — PRD, user stories → docs/sdlc/po/
|
|
250
270
|
2. **Business BA** — FRS, process flows → docs/sdlc/ba/business/
|
|
251
271
|
3. **Architect** — ADRs, diagrams → docs/sdlc/architecture/
|
|
252
272
|
4. **Technical BA** — API specs, team breakdown → docs/sdlc/ba/technical/
|
|
253
|
-
5. **
|
|
254
|
-
6. **
|
|
255
|
-
7. **
|
|
273
|
+
5. **QE (docs)** — Test plan, test cases → docs/sdlc/qe/
|
|
274
|
+
6. **Dev** — After QE docs: Tech Lead (15+ yrs, tech stack, review & merge) + Senior Dev (10+ yrs, implement, Unit Test ≥90%) → docs/sdlc/dev/{role}/
|
|
275
|
+
7. **QE (testing)** — After Dev unit tests: automation + manual, sign-off
|
|
276
|
+
8. **Deploy** — Release, monitor
|
|
256
277
|
|
|
257
|
-
Flow:
|
|
278
|
+
Flow: ... → Technical BA → QE docs → Dev → QE testing → Deploy
|
|
258
279
|
Ask "Which phase are we in?" if unclear.
|
|
259
280
|
`;
|
|
260
281
|
|
|
@@ -266,7 +287,7 @@ For Cursor, see .cursor/rules/sdlc-workflow.mdc
|
|
|
266
287
|
## Flow
|
|
267
288
|
|
|
268
289
|
\`\`\`
|
|
269
|
-
User Request → PO → Business BA → Architect → Technical BA →
|
|
290
|
+
User Request → PO → Business BA → Architect → Technical BA → QE (docs) → Dev → QE (testing) → Deploy
|
|
270
291
|
\`\`\`
|
|
271
292
|
|
|
272
293
|
## Phase Checklist
|
|
@@ -278,8 +299,9 @@ User Request → PO → Business BA → Architect → Technical BA → Dev Teams
|
|
|
278
299
|
| 2 | Business BA | FRS, process flows |
|
|
279
300
|
| 3 | Architect | ADRs, system diagrams |
|
|
280
301
|
| 4 | Technical BA | API specs, tech breakdown |
|
|
281
|
-
|
|
|
282
|
-
|
|
|
302
|
+
| 5a | QE (docs) | Test plan, test cases |
|
|
303
|
+
| 5b | Dev | Code, unit tests (≥90%) |
|
|
304
|
+
| 6 | QE (testing) | Automation + manual, sign-off |
|
|
283
305
|
| 7 | Ops | Deploy, monitor |
|
|
284
306
|
|
|
285
307
|
## Phase Details
|
|
@@ -300,12 +322,22 @@ User Request → PO → Business BA → Architect → Technical BA → Dev Teams
|
|
|
300
322
|
- API specs, DB schema, team breakdown
|
|
301
323
|
- Output: \`docs/sdlc/ba/technical/\`
|
|
302
324
|
|
|
303
|
-
### Phase
|
|
304
|
-
-
|
|
305
|
-
|
|
306
|
-
### Phase 6: QE
|
|
307
|
-
- Test plan, test cases, sign-off
|
|
325
|
+
### Phase 5a: QE (Docs)
|
|
326
|
+
- Test plan, test cases — **before Dev implements**
|
|
308
327
|
- Output: \`docs/sdlc/qe/\`
|
|
328
|
+
- **Then**: Dev team starts implementation
|
|
329
|
+
|
|
330
|
+
### Phase 5b: Dev Teams
|
|
331
|
+
- **Tech Lead (15+ yrs)**: Tech stack, libraries; review & merge. Output: \`docs/sdlc/dev/tech-lead/\`
|
|
332
|
+
- **Senior Developer (10+ yrs)**: Implement features. Output: \`docs/sdlc/dev/senior-developer/\`
|
|
333
|
+
- **Requirement**: Unit Test coverage **≥ 90%**
|
|
334
|
+
- **Then**: QE starts testing phase
|
|
335
|
+
|
|
336
|
+
### Phase 6: QE (Testing)
|
|
337
|
+
- After Dev unit tests complete: automation tests + manual tests, sign-off
|
|
338
|
+
|
|
339
|
+
### Phase 7: Deploy
|
|
340
|
+
- Release, monitor
|
|
309
341
|
|
|
310
342
|
See [reference.md](./reference.md) for templates.
|
|
311
343
|
`;
|
|
@@ -433,8 +465,31 @@ const QE_TC_TEMPLATE = `## TC-001: [Scenario]
|
|
|
433
465
|
|
|
434
466
|
const QE_README = `# QE (Quality Engineering)
|
|
435
467
|
|
|
436
|
-
|
|
468
|
+
Two phases:
|
|
469
|
+
1. **Docs phase** — Test plan, test cases (before Dev implements). Output ready for Dev team.
|
|
470
|
+
2. **Testing phase** — After Dev completes unit tests: run tests, include automation tests, sign-off.
|
|
471
|
+
|
|
437
472
|
Use test-case.template.md for test cases.
|
|
438
473
|
`;
|
|
439
474
|
|
|
475
|
+
const DEV_TECH_LEAD_README = `# Tech Lead (15+ years exp)
|
|
476
|
+
|
|
477
|
+
**Responsibilities**:
|
|
478
|
+
- Decide tech stack, frameworks, libraries
|
|
479
|
+
- Review and merge code
|
|
480
|
+
- Ensure architecture alignment
|
|
481
|
+
|
|
482
|
+
**Docs**: ADRs, tech decisions, review checklist.
|
|
483
|
+
`;
|
|
484
|
+
|
|
485
|
+
const DEV_SENIOR_README = `# Senior Developer (10+ years exp)
|
|
486
|
+
|
|
487
|
+
**Responsibilities**:
|
|
488
|
+
- Implement features per Technical BA spec
|
|
489
|
+
- Write code with Unit Test coverage **≥ 90%**
|
|
490
|
+
- Follow Tech Lead's tech decisions
|
|
491
|
+
|
|
492
|
+
**Docs**: Implementation notes, API usage.
|
|
493
|
+
`;
|
|
494
|
+
|
|
440
495
|
main();
|