sdlc-workflow 1.0.9 → 1.0.10

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 (2) hide show
  1. package/bin/cli.js +134 -21
  2. package/package.json +1 -1
package/bin/cli.js CHANGED
@@ -703,16 +703,16 @@ const PO_README = `# PO (Product Owner)
703
703
  - Folder name = epic/feature slug (e.g. \`job-scheduler-event-bus\`, \`user-auth\`).
704
704
  - Inside that folder: \`epic-brief.md\`, \`user-stories.md\`, \`prd.md\` (or similar) for that epic only.
705
705
 
706
- Example:
707
- \`\`\`
708
- docs/sdlc/po/
709
- job-scheduler-event-bus/
710
- epic-brief.md
711
- user-stories.md
712
- user-auth/
713
- epic-brief.md
714
- user-stories.md
715
- \`\`\`
706
+ ## Detailed tasks
707
+
708
+ - [ ] **Clarify vision**: Capture business problem, goals, success metrics
709
+ - [ ] **Define scope**: Boundaries, in/out of scope, MVP vs later
710
+ - [ ] **Write epic brief**: Problem, success metrics, high-level approach, project type
711
+ - [ ] **Break into user stories**: As a [role], I want [goal] so that [benefit]; acceptance criteria per story
712
+ - [ ] **Prioritize**: Must / Should / Could have; order by value and risk
713
+ - [ ] **Identify dependencies**: External teams, systems, blockers
714
+ - [ ] **Call out risks**: Technical, schedule, compliance
715
+ - [ ] **Handoff to Business BA**: Deliverables in \`po/{epic-slug}/\`
716
716
 
717
717
  Use epic-brief.template.md as starting point for each epic.
718
718
  `;
@@ -755,7 +755,17 @@ docs/sdlc/ba/business/
755
755
  functional-requirements.md
756
756
  \`\`\`
757
757
 
758
- Use functional-requirement.template.md for FRS items. One file per epic, or one folder per epic with multiple files.
758
+ ## Detailed tasks
759
+
760
+ - [ ] **Read PO outputs**: Epic brief, user stories, acceptance criteria
761
+ - [ ] **Define functional requirements**: For each requirement: type, description, trigger, process flow, output, constraints (use FR-001, FR-002...)
762
+ - [ ] **Document process flows**: Step-by-step business flows (e.g. BPMN, flowcharts, numbered lists)
763
+ - [ ] **Write use cases**: Actor, goal, preconditions, main/alternate flows, postconditions
764
+ - [ ] **Maintain glossary**: Business terms, definitions, acronyms
765
+ - [ ] **Map to user stories**: Trace FRs to user stories / AC
766
+ - [ ] **Handoff to Architect**: Deliverables in \`ba/business/{epic-slug}/\`
767
+
768
+ Use functional-requirement.template.md for FRS items.
759
769
  `;
760
770
 
761
771
  const TECH_API_TEMPLATE = `# Interface / contract spec
@@ -856,6 +866,15 @@ const BA_TECH_README = `# Technical BA
856
866
 
857
867
  API/interface specs, DB schema, team breakdown.
858
868
  Templates support: HTTP API, library/SDK, CLI, and all project types (see api-spec and team-breakdown).
869
+
870
+ ## Detailed tasks
871
+
872
+ - [ ] **Read Architect outputs**: ADRs, context/container diagrams, tech stack
873
+ - [ ] **API/interface spec**: For each endpoint/class/command: purpose, request/response, contract (OpenAPI, TS types, CLI help)
874
+ - [ ] **DB schema**: Tables, columns, indexes, constraints; migrations approach
875
+ - [ ] **Team breakdown**: Map scope to teams (Backend, Frontend, Mobile, etc.) per project type; dependencies
876
+ - [ ] **Trace to FRs**: Map technical specs to functional requirements
877
+ - [ ] **Handoff to QE + Dev**: API spec, team breakdown in \`ba/technical/\`
859
878
  `;
860
879
 
861
880
  const ARCH_ADR_TEMPLATE = `# ADR-001: [Decision Title]
@@ -877,10 +896,20 @@ const ARCH_ADR_TEMPLATE = `# ADR-001: [Decision Title]
877
896
  - Negative: ...
878
897
  `;
879
898
 
880
- const ARCH_README = `# Architecture
899
+ const ARCH_README = `# Architect
881
900
 
882
901
  ADRs, system diagrams, tech stack decisions.
883
902
  Use adr.template.md for new ADRs.
903
+
904
+ ## Detailed tasks
905
+
906
+ - [ ] **Read Business BA outputs**: Functional requirements, process flows, use cases
907
+ - [ ] **Context diagram**: System boundary, external actors, integrations
908
+ - [ ] **Container diagram**: Main components/services and their responsibilities
909
+ - [ ] **Tech stack decisions**: Languages, frameworks, databases; document in ADRs
910
+ - [ ] **ADR per decision**: Context, decision, consequences (scope: backend, frontend, mobile, etc.)
911
+ - [ ] **Non-functional alignment**: Performance, security, scalability, compliance
912
+ - [ ] **Handoff to Technical BA**: Architecture docs, ADRs in \`architecture/\`
884
913
  `;
885
914
 
886
915
  const QE_TC_TEMPLATE = `## TC-001: [Scenario]
@@ -909,6 +938,19 @@ const QE_README = `# QE (Quality Engineering)
909
938
  - Use the same epic/feature slug as PO and Business BA: \`docs/sdlc/qe/{epic-slug}/\`
910
939
  - Inside that folder: \`test-plan.md\`, \`test-cases.md\` (Phase 5a), and for Phase 6: automation notes, framework decision for that epic, etc.
911
940
 
941
+ ## Detailed tasks (Docs phase — Phase 5a)
942
+
943
+ - [ ] **Read Technical BA spec**: API, team breakdown, FRs
944
+ - [ ] **Test plan**: Scope (unit, integration, E2E), coverage goals, risks
945
+ - [ ] **Test cases**: TC-001, TC-002... — precondition, steps, expected, links to AC
946
+ - [ ] **Handoff to Dev**: Test plan + test cases in \`qe/{epic-slug}/\` → Dev runs implementation
947
+
948
+ ## Detailed tasks (Testing phase — Phase 6)
949
+
950
+ - [ ] **QE Lead**: Test strategy, framework, review test code
951
+ - [ ] **Senior QE**: Write automation tests per test plan
952
+ - [ ] **Sign-off**: Regression, coverage, release readiness in \`qe/{epic-slug}/\`
953
+
912
954
  Example:
913
955
  \`\`\`
914
956
  docs/sdlc/qe/
@@ -940,6 +982,15 @@ const QE_LEAD_README = `# QE Lead (15+ years exp in test automation)
940
982
  - **Quality gates**: Define and enforce gates (e.g. coverage thresholds, required suites before merge, regression criteria).
941
983
 
942
984
  **Output**: Test framework ADR, automation strategy doc, review checklist, and per-epic guidance in \`docs/sdlc/qe/{epic-slug}/\`.
985
+
986
+ ## Detailed tasks
987
+
988
+ - [ ] **Test automation strategy**: Document scope (unit/integration/E2E/API/performance), pyramid, alignment with tech stack
989
+ - [ ] **Framework ADR**: Choose and justify frameworks (Playwright, Cypress, Jest, etc.); document in ADR
990
+ - [ ] **Automation architecture**: Design folder structure, layers, fixtures, reporting, retries, env handling
991
+ - [ ] **Review checklist**: Coverage, maintainability, naming, alignment with framework
992
+ - [ ] **Quality gates**: Define thresholds (coverage, required suites before merge), regression criteria
993
+ - [ ] **Per-epic guidance**: Output to \`qe/{epic-slug}/\` per epic
943
994
  `;
944
995
 
945
996
  const QE_SENIOR_README = `# Senior QE (10+ years exp)
@@ -949,7 +1000,14 @@ const QE_SENIOR_README = `# Senior QE (10+ years exp)
949
1000
  - Implement E2E, integration, regression tests
950
1001
  - Follow QE Lead's framework decisions
951
1002
 
952
- **Docs**: Automation test design, framework usage.
1003
+ ## Detailed tasks
1004
+
1005
+ - [ ] **Read test plan**: Scope, coverage goals, test case IDs
1006
+ - [ ] **Implement E2E tests**: UI flows, critical paths per QE Lead's framework
1007
+ - [ ] **Implement API/integration tests**: Request/response, contracts
1008
+ - [ ] **Implement regression suite**: Add to CI; ensure stability (retries, waits)
1009
+ - [ ] **Report coverage**: Align with QE Lead's quality gates
1010
+ - [ ] **Output**: Automation code and docs in \`qe/{epic-slug}/\`
953
1011
  `;
954
1012
 
955
1013
  const DEV_TECH_LEAD_README = `# Tech Lead (15+ years exp)
@@ -959,7 +1017,15 @@ const DEV_TECH_LEAD_README = `# Tech Lead (15+ years exp)
959
1017
  - Review and merge code
960
1018
  - Ensure architecture alignment
961
1019
 
962
- **Docs**: ADRs, tech decisions, review checklist.
1020
+ ## Detailed tasks
1021
+
1022
+ - [ ] **Read architecture and Technical BA spec**: ADRs, API spec, team breakdown
1023
+ - [ ] **Tech stack decision**: Languages, frameworks, libraries; document in ADR
1024
+ - [ ] **Project setup**: Repo structure, tooling, lint, format, CI baseline
1025
+ - [ ] **Code review**: Architecture alignment, patterns, test coverage, security
1026
+ - [ ] **Merge approval**: Enforce quality gates before merge
1027
+ - [ ] **Tech guidance**: Resolve technical disputes; mentor team
1028
+ - [ ] **Output**: ADRs, review checklist in \`dev/tech-lead/\`
963
1029
  `;
964
1030
 
965
1031
  const DEV_SENIOR_README = `# Senior Developer (10+ years exp)
@@ -969,7 +1035,13 @@ const DEV_SENIOR_README = `# Senior Developer (10+ years exp)
969
1035
  - Write code with Unit Test coverage **≥ 90%**
970
1036
  - Follow Tech Lead's tech decisions
971
1037
 
972
- **Docs**: Implementation notes, API usage.
1038
+ ## Detailed tasks
1039
+
1040
+ - [ ] **Read Technical BA spec**: API, schema, team breakdown
1041
+ - [ ] **Implement feature**: Code per spec; follow Tech Lead stack
1042
+ - [ ] **Unit tests**: Coverage **≥ 90%**; edge cases, error paths
1043
+ - [ ] **PR**: Lint, tests passing; request Tech Lead review
1044
+ - [ ] **Output**: Code + implementation notes in \`dev/senior-developer/\`
973
1045
  `;
974
1046
 
975
1047
  const DEV_IMPLEMENTATION_ROLES_TEMPLATE = `# Implementation roles by project type
@@ -1009,7 +1081,14 @@ const DEV_FRONTEND_README = `# Senior Frontend (10+ years exp) — Web UI
1009
1081
  - Unit Test coverage **≥ 90%**
1010
1082
  - Follow Tech Lead's stack (e.g. React, Vue, Angular)
1011
1083
 
1012
- **Docs**: Component docs, integration notes.
1084
+ ## Detailed tasks
1085
+
1086
+ - [ ] **Read Technical BA spec**: API contract, design (if any)
1087
+ - [ ] **Implement components/screens**: Per spec; responsive, accessible
1088
+ - [ ] **API integration**: Fetch, state, error handling
1089
+ - [ ] **Unit tests**: Components, hooks, utils — coverage **≥ 90%**
1090
+ - [ ] **PR**: Lint, tests; Tech Lead review
1091
+ - [ ] **Output**: Code + component/integration docs in \`dev/frontend/\`
1013
1092
  `;
1014
1093
 
1015
1094
  const DEV_BACKEND_README = `# Senior Backend (10+ years exp) — API, services
@@ -1019,7 +1098,14 @@ const DEV_BACKEND_README = `# Senior Backend (10+ years exp) — API, services
1019
1098
  - Unit Test coverage **≥ 90%**
1020
1099
  - Follow Tech Lead's stack
1021
1100
 
1022
- **Docs**: API implementation notes, DB changes.
1101
+ ## Detailed tasks
1102
+
1103
+ - [ ] **Read Technical BA spec**: API spec, DB schema
1104
+ - [ ] **Implement endpoints**: Per spec; validation, auth, error responses
1105
+ - [ ] **Implement DB layer**: Migrations, queries, transactions
1106
+ - [ ] **Unit tests**: Services, controllers, DB — coverage **≥ 90%**
1107
+ - [ ] **PR**: Lint, tests; Tech Lead review
1108
+ - [ ] **Output**: Code + API/DB implementation notes in \`dev/backend/\`
1023
1109
  `;
1024
1110
 
1025
1111
  const DEV_MOBILE_README = `# Senior Mobile (10+ years exp) — iOS / Android / cross-platform
@@ -1029,7 +1115,14 @@ const DEV_MOBILE_README = `# Senior Mobile (10+ years exp) — iOS / Android / c
1029
1115
  - Unit Test coverage **≥ 90%**
1030
1116
  - Follow Tech Lead's stack (e.g. React Native, Flutter, native)
1031
1117
 
1032
- **Docs**: Screen/module docs, integration notes.
1118
+ ## Detailed tasks
1119
+
1120
+ - [ ] **Read Technical BA spec**: API contract, screen flows
1121
+ - [ ] **Implement screens/modules**: Per spec; platform parity (iOS/Android)
1122
+ - [ ] **API integration**: Auth, state, offline (if required)
1123
+ - [ ] **Unit tests**: Components, logic — coverage **≥ 90%**
1124
+ - [ ] **PR**: Lint, tests; Tech Lead review
1125
+ - [ ] **Output**: Code + screen/module docs in \`dev/mobile/\`
1033
1126
  `;
1034
1127
 
1035
1128
  const DEV_EMBEDDED_README = `# Senior Embedded (10+ years exp) — firmware, IoT
@@ -1039,7 +1132,13 @@ const DEV_EMBEDDED_README = `# Senior Embedded (10+ years exp) — firmware, IoT
1039
1132
  - Tests as appropriate for target (unit, HW-in-loop)
1040
1133
  - Follow Tech Lead's stack and safety constraints
1041
1134
 
1042
- **Docs**: Module design, interface specs.
1135
+ ## Detailed tasks
1136
+
1137
+ - [ ] **Read Technical BA spec**: Interfaces, timing, constraints
1138
+ - [ ] **Implement modules/drivers**: Per spec; safety-critical compliance
1139
+ - [ ] **Tests**: Unit, HW-in-loop as feasible
1140
+ - [ ] **PR**: Lint, tests; Tech Lead review
1141
+ - [ ] **Output**: Code + module/interface docs in \`dev/embedded/\`
1043
1142
  `;
1044
1143
 
1045
1144
  const DEV_DATA_ML_README = `# Senior Data/ML (10+ years exp)
@@ -1049,7 +1148,14 @@ const DEV_DATA_ML_README = `# Senior Data/ML (10+ years exp)
1049
1148
  - Tests and validation for data and model quality
1050
1149
  - Follow Tech Lead's stack (e.g. Python, Spark, ML frameworks)
1051
1150
 
1052
- **Docs**: Pipeline design, model cards.
1151
+ ## Detailed tasks
1152
+
1153
+ - [ ] **Read Technical BA spec**: Data spec, API contract
1154
+ - [ ] **Implement ETL/pipelines**: Ingestion, transforms, storage
1155
+ - [ ] **Implement models**: Training, evaluation; model cards
1156
+ - [ ] **Tests**: Data validation, model quality metrics
1157
+ - [ ] **PR**: Lint, tests; Tech Lead review
1158
+ - [ ] **Output**: Code + pipeline/model docs in \`dev/data-ml/\`
1053
1159
  `;
1054
1160
 
1055
1161
  const DEV_PLATFORM_README = `# Senior Platform (10+ years exp) — infra, CI/CD
@@ -1058,7 +1164,14 @@ const DEV_PLATFORM_README = `# Senior Platform (10+ years exp) — infra, CI/CD
1058
1164
  - Implement CI/CD, infra as code, observability per spec
1059
1165
  - Follow Tech Lead's stack and security requirements
1060
1166
 
1061
- **Docs**: Runbooks, pipeline and infra docs.
1167
+ ## Detailed tasks
1168
+
1169
+ - [ ] **Read Technical BA spec**: Infra, deploy, observability requirements
1170
+ - [ ] **Implement CI/CD**: Build, test, deploy pipelines
1171
+ - [ ] **Infra as code**: Terraform/Pulumi/CloudFormation per spec
1172
+ - [ ] **Observability**: Logging, metrics, traces, alerts
1173
+ - [ ] **PR**: Lint; Tech Lead review
1174
+ - [ ] **Output**: Pipelines, infra code, runbooks in \`dev/platform/\`
1062
1175
  `;
1063
1176
 
1064
1177
  main();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sdlc-workflow",
3
- "version": "1.0.9",
3
+ "version": "1.0.10",
4
4
  "description": "Scaffold SDLC workflow docs and templates for Cursor, Claude, and dev teams",
5
5
  "type": "module",
6
6
  "bin": {