sdlc-workflow 1.0.3 → 1.0.5

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.
Files changed (3) hide show
  1. package/README.md +5 -5
  2. package/bin/cli.js +25 -25
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -8,10 +8,10 @@ Scaffold SDLC workflow docs and templates into your project. Works with **Cursor
8
8
  User Request → PO → Business BA → Architect → Technical BA → QE (docs) → Dev → QE (testing) → Deploy (Docker Compose + K8s)
9
9
  ```
10
10
 
11
- - **Mỗi role chạy bằng sub-agent** (xem `docs/sdlc/agents/`).
12
- - **Sau khi hoàn thành** → triển khai ngay với **Docker Compose** (local/staging) **Kubernetes** (production) — `docs/sdlc/deploy/`.
11
+ - **Each role runs as a sub-agent** (see `docs/sdlc/agents/`).
12
+ - **After completion** → deploy immediately with **Docker Compose** (local/staging) and **Kubernetes** (production) — `docs/sdlc/deploy/`.
13
13
  - **QE (docs)**: Test plan, test cases
14
- - **Dev**: Sau bước tài liệu → **run implement luôn**. Tech Lead (review, merge) + Senior Dev (implement, Unit Test ≥90%)
14
+ - **Dev**: After docs phase → **run implementation immediately**. Tech Lead (review, merge) + Senior Dev (implement, Unit Test ≥90%)
15
15
  - **QE (testing)**: QE Lead (test framework, review) + Senior QE (10+ yrs, write automation tests)
16
16
 
17
17
  ## Usage
@@ -68,9 +68,9 @@ docs/sdlc/
68
68
  │ │ └── README.md
69
69
  │ └── senior-developer/ # Senior Dev 10+ yrs: implement, Unit Test ≥90%
70
70
  │ └── README.md
71
- ├── agents/ # Sub-agent specs (mỗi role = sub-agent)
71
+ ├── agents/ # Sub-agent specs (each role = sub-agent)
72
72
  │ └── README.md
73
- └── deploy/ # Sau khi hoàn thành → Docker Compose + K8s
73
+ └── deploy/ # After completion → Docker Compose + K8s
74
74
  ├── README.md
75
75
  ├── docker-compose.yml.template
76
76
  └── k8s/
package/bin/cli.js CHANGED
@@ -208,22 +208,22 @@ globs: docs/sdlc/**/*, **/*.md
208
208
  3. **Architect** — ADRs, diagrams → docs/sdlc/architecture/
209
209
  4. **Technical BA** — API specs, team breakdown → docs/sdlc/ba/technical/
210
210
  5. **QE (docs)** — Test plan, test cases → docs/sdlc/qe/
211
- 6. **Dev** — Sau bước tài liệu → **run implement ngay**. Tech Lead (review, merge) + Senior Dev (implement, ≥90% unit test) → docs/sdlc/dev/{role}/
211
+ 6. **Dev** — After docs phase → **run implementation immediately**. Tech Lead (review, merge) + Senior Dev (implement, ≥90% unit test) → docs/sdlc/dev/{role}/
212
212
  7. **QE (testing)** — QE Lead (test framework, review) + Senior QE (10+ yrs, automation) → docs/sdlc/qe/{role}/
213
213
  8. **Deploy** — Docker Compose + K8s → docs/sdlc/deploy/
214
214
 
215
- **Mỗi role chạy bằng sub-agent.** Xem docs/sdlc/agents/
215
+ **Each role runs as a sub-agent.** See docs/sdlc/agents/
216
216
  Full workflow: docs/sdlc/SDLC-WORKFLOW.md
217
217
  `;
218
218
 
219
219
  const CURSOR_SKILL_MD = `---
220
220
  name: sdlc-workflow
221
- description: Multi-role SDLC workflow from user requirements through PO, Business BA, Architect, Technical BA, Dev teams, and QE. Use when user mentions SDLC, requirements, PO, BA, Architect, technical spec, phased development, yêu cầu, phân rã, kiến trúc, or handoff between roles.
221
+ description: Multi-role SDLC workflow from user requirements through PO, Business BA, Architect, Technical BA, Dev teams, and QE. Use when user mentions SDLC, requirements, PO, BA, Architect, technical spec, phased development, or handoff between roles.
222
222
  ---
223
223
 
224
224
  # SDLC Workflow (Multi-Role)
225
225
 
226
- Sequential workflow; **mỗi role chạy bằng sub-agent**. Each phase produces docs/artifacts for the next. Sau khi hoàn thành triển khai với **Docker Compose** **K8s** (docs/sdlc/deploy/).
226
+ Sequential workflow; **each role runs as a sub-agent**. Each phase produces docs/artifacts for the next. After completiondeploy with **Docker Compose** and **K8s** (docs/sdlc/deploy/).
227
227
 
228
228
  ## Flow Overview
229
229
 
@@ -269,11 +269,11 @@ User Request → PO → Business BA → Architect → Technical BA → QE (docs)
269
269
 
270
270
  **Role**: Create test plan, test cases before Dev implements.
271
271
  **Deliverables**: Test plan, test cases.
272
- **Output**: \`docs/sdlc/qe/\` — Hết bước tài liệu → **Dev team chạy implement ngay** (không chờ thêm).
272
+ **Output**: \`docs/sdlc/qe/\` — After docs phase → **Dev team runs implementation immediately** (no extra gate).
273
273
 
274
274
  ## Phase 5b: Dev Teams
275
275
 
276
- **Trigger**: Sau khi xong tài liệu (Technical BA + QE docs). **Dev run implement luôn.**
276
+ **Trigger**: After docs are done (Technical BA + QE docs). **Dev runs implementation immediately.**
277
277
 
278
278
  **Roles**:
279
279
  - **Tech Lead (15+ yrs)**: Decide tech stack, libraries; review & merge code. Docs: \`docs/sdlc/dev/tech-lead/\`
@@ -297,8 +297,8 @@ User Request → PO → Business BA → Architect → Technical BA → QE (docs)
297
297
  ## Phase 7: Deploy
298
298
 
299
299
  **Trigger**: After QE sign-off.
300
- **Role**: Triển khai với **Docker Compose** (local/staging) **Kubernetes** (production).
301
- **Output**: \`docs/sdlc/deploy/\` — docker-compose.yml, k8s manifests. Deploy ngay sau khi hoàn thành pipeline.
300
+ **Role**: Deploy with **Docker Compose** (local/staging) and **Kubernetes** (production).
301
+ **Output**: \`docs/sdlc/deploy/\` — docker-compose.yml, k8s manifests. Deploy right after pipeline completes.
302
302
 
303
303
  ## Quick Phase Checklist
304
304
 
@@ -314,7 +314,7 @@ User Request → PO → Business BA → Architect → Technical BA → QE (docs)
314
314
  | 6 | QE (testing) | QE Lead + Senior QE, automation, sign-off |
315
315
  | 7 | Deploy | Docker Compose + K8s |
316
316
 
317
- **Sub-agents**: Mỗi role = 1 sub-agent (PO, Business BA, Architect, Technical BA, QE Lead, Senior QE, Tech Lead, Senior Dev). See docs/sdlc/agents/
317
+ **Sub-agents**: Each role = one sub-agent (PO, Business BA, Architect, Technical BA, QE Lead, Senior QE, Tech Lead, Senior Dev). See docs/sdlc/agents/
318
318
  See reference.md for templates.
319
319
  `;
320
320
 
@@ -345,10 +345,10 @@ TC-001: [Scenario] — Precondition, Steps, Expected, Links to AC
345
345
  - Senior Dev (10+ yrs): implement, Unit Test ≥90% → docs/sdlc/dev/senior-developer/
346
346
 
347
347
  ## Sub-agents
348
- Mỗi role = sub-agent. See docs/sdlc/agents/
348
+ Each role = sub-agent. See docs/sdlc/agents/
349
349
 
350
350
  ## Deploy
351
- Sau khi hoàn thành → Docker Compose + K8s. See docs/sdlc/deploy/
351
+ After completion → Docker Compose + K8s. See docs/sdlc/deploy/
352
352
  `;
353
353
 
354
354
  const AGENTS_MD_CONTENT = `## SDLC Workflow
@@ -360,11 +360,11 @@ When working on requirements, features, or handoffs, follow these phases:
360
360
  3. **Architect** — ADRs, diagrams → docs/sdlc/architecture/
361
361
  4. **Technical BA** — API specs, team breakdown → docs/sdlc/ba/technical/
362
362
  5. **QE (docs)** — Test plan, test cases → docs/sdlc/qe/
363
- 6. **Dev** — Sau bước tài liệu → **run implement luôn**. Tech Lead + Senior Dev → docs/sdlc/dev/{role}/
363
+ 6. **Dev** — After docs phase → **run implementation immediately**. Tech Lead + Senior Dev → docs/sdlc/dev/{role}/
364
364
  7. **QE (testing)** — QE Lead + Senior QE (automation)
365
365
  8. **Deploy** — Docker Compose + K8s → docs/sdlc/deploy/
366
366
 
367
- Sau bước làm tài liệu thì cho team Dev run implement ngay. See docs/sdlc/agents/
367
+ After the docs phase, the Dev team runs implementation immediately. See docs/sdlc/agents/
368
368
  `;
369
369
 
370
370
  const CLAUDE_SDLC_CONTENT = `## SDLC Workflow
@@ -374,11 +374,11 @@ const CLAUDE_SDLC_CONTENT = `## SDLC Workflow
374
374
  3. **Architect** — ADRs, diagrams → docs/sdlc/architecture/
375
375
  4. **Technical BA** — API specs, team breakdown → docs/sdlc/ba/technical/
376
376
  5. **QE (docs)** — Test plan, test cases → docs/sdlc/qe/
377
- 6. **Dev** — Sau bước tài liệu → **run implement luôn**. Tech Lead + Senior Dev → docs/sdlc/dev/{role}/
377
+ 6. **Dev** — After docs phase → **run implementation immediately**. Tech Lead + Senior Dev → docs/sdlc/dev/{role}/
378
378
  7. **QE (testing)** — QE Lead + Senior QE (automation)
379
379
  8. **Deploy** — Docker Compose + K8s → docs/sdlc/deploy/
380
380
 
381
- Sau bước làm tài liệu (Technical BA + QE docs) thì cho team Dev run implement ngay. See docs/sdlc/agents/
381
+ After the docs phase (Technical BA + QE docs), the Dev team runs implementation immediately. See docs/sdlc/agents/
382
382
  `;
383
383
 
384
384
  const SDLC_WORKFLOW_MD = `# SDLC Workflow (Multi-Role)
@@ -406,7 +406,7 @@ User Request → PO → Business BA → Architect → Technical BA → QE (docs)
406
406
  | 6 | QE (testing) | QE Lead + Senior QE, automation, sign-off |
407
407
  | 7 | Deploy | Docker Compose + K8s |
408
408
 
409
- **Sub-agents**: Mỗi role chạy bằng sub-agent (PO, Business BA, Architect, Technical BA, QE Lead, Senior QE, Tech Lead, Senior Dev). See docs/sdlc/agents/
409
+ **Sub-agents**: Each role runs as a sub-agent (PO, Business BA, Architect, Technical BA, QE Lead, Senior QE, Tech Lead, Senior Dev). See docs/sdlc/agents/
410
410
 
411
411
  ## Phase Details
412
412
 
@@ -429,7 +429,7 @@ User Request → PO → Business BA → Architect → Technical BA → QE (docs)
429
429
  ### Phase 5a: QE (Docs)
430
430
  - Test plan, test cases
431
431
  - Output: \`docs/sdlc/qe/\`
432
- - **Sau bước tài liệu → Dev team run implement luôn** (không chờ thêm)
432
+ - **After docs phase → Dev team runs implementation immediately** (no extra gate)
433
433
 
434
434
  ### Phase 5b: Dev Teams
435
435
  - **Tech Lead (15+ yrs)**: Tech stack, libraries; review & merge. Output: \`docs/sdlc/dev/tech-lead/\`
@@ -442,7 +442,7 @@ User Request → PO → Business BA → Architect → Technical BA → QE (docs)
442
442
  - **Senior QE (10+ yrs)**: Write automation tests. Output: \`docs/sdlc/qe/senior-qe/\`
443
443
 
444
444
  ### Phase 7: Deploy
445
- - Sau khi hoàn thành pipeline triển khai với **Docker Compose** (local/staging) **Kubernetes** (production)
445
+ - After pipeline completesdeploy with **Docker Compose** (local/staging) and **Kubernetes** (production)
446
446
  - Output: \`docs/sdlc/deploy/\` — docker-compose.yml, k8s/
447
447
 
448
448
  See [reference.md](./reference.md) for templates.
@@ -457,7 +457,7 @@ Deploy: docs/sdlc/deploy/ (Docker Compose + K8s)
457
457
 
458
458
  const AGENTS_README = `# Sub-Agents
459
459
 
460
- Mọi role trong SDLC chạy bằng **sub-agent**. Mỗi phase giao cho một sub-agent tương ứng.
460
+ Every role in the SDLC runs as a **sub-agent**. Each phase is assigned to a corresponding sub-agent.
461
461
 
462
462
  | Role | Sub-agent | Input | Output |
463
463
  |------|-----------|--------|--------|
@@ -467,24 +467,24 @@ Mọi role trong SDLC chạy bằng **sub-agent**. Mỗi phase giao cho một su
467
467
  | Technical BA | technical-ba | docs/sdlc/architecture/ | docs/sdlc/ba/technical/ |
468
468
  | QE (docs) | qe-docs | docs/sdlc/ba/technical/ | docs/sdlc/qe/ (test plan) |
469
469
  | Tech Lead | tech-lead | Technical spec | Review, merge, docs/sdlc/dev/tech-lead/ |
470
- | Senior Dev | senior-dev | Spec + test plan | **Sau tài liệu → run implement ngay**. Code, unit tests (≥90%) |
470
+ | Senior Dev | senior-dev | Spec + test plan | After docs → run implementation immediately. Code, unit tests (≥90%) |
471
471
  | QE Lead | qe-lead | Test plan | Test framework, review, docs/sdlc/qe/qe-lead/ |
472
472
  | Senior QE | senior-qe | Test plan + framework | Automation tests, docs/sdlc/qe/senior-qe/ |
473
473
  | Deploy | deploy | QE sign-off | Docker Compose + K8s, docs/sdlc/deploy/ |
474
474
 
475
- Orchestrator: chạy từng sub-agent theo thứ tự; handoff output → input của sub-agent tiếp theo.
475
+ Orchestrator: run each sub-agent in order; hand off output → input of the next sub-agent.
476
476
  `;
477
477
 
478
478
  const DEPLOY_README = `# Deploy
479
479
 
480
- Sau khi hoàn thành pipeline (QE sign-off), triển khai ngay với:
480
+ After the pipeline completes (QE sign-off), deploy immediately with:
481
481
 
482
482
  - **Docker Compose** — local / staging: \`docker compose up -d\`
483
483
  - **Kubernetes** — production: \`kubectl apply -f k8s/\`
484
484
 
485
485
  ## Files
486
486
 
487
- - \`docker-compose.yml.template\` — copy thành \`docker-compose.yml\`, chỉnh image/env
487
+ - \`docker-compose.yml.template\` — copy to \`docker-compose.yml\`, adjust image/env
488
488
  - \`k8s/deployment.yaml.template\` — Deployment
489
489
  - \`k8s/service.yaml.template\` — Service
490
490
  - \`k8s/ingress.yaml.template\` — Ingress (optional)
@@ -677,8 +677,8 @@ const QE_TC_TEMPLATE = `## TC-001: [Scenario]
677
677
  const QE_README = `# QE (Quality Engineering)
678
678
 
679
679
  Two phases:
680
- 1. **Docs phase** — Test plan, test cases. Xong → **Dev run implement luôn**.
681
- 2. **Testing phase** — Sau khi Dev xong unit tests: QE team viết automation tests.
680
+ 1. **Docs phase** — Test plan, test cases. Done → **Dev runs implementation immediately**.
681
+ 2. **Testing phase** — After Dev completes unit tests: QE team writes automation tests.
682
682
  - **QE Lead**: Decide test framework; review test code → docs/sdlc/qe/qe-lead/
683
683
  - **Senior QE (10+ yrs)**: Write automation tests → docs/sdlc/qe/senior-qe/
684
684
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sdlc-workflow",
3
- "version": "1.0.3",
3
+ "version": "1.0.5",
4
4
  "description": "Scaffold SDLC workflow docs and templates for Cursor, Claude, and dev teams",
5
5
  "type": "module",
6
6
  "bin": {
@@ -19,7 +19,8 @@
19
19
  "author": "",
20
20
  "license": "MIT",
21
21
  "files": [
22
- "bin"
22
+ "bin",
23
+ "README.md"
23
24
  ],
24
25
  "engines": {
25
26
  "node": ">=18"