@comfanion/workflow 4.1.3 → 4.5.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.
Files changed (58) hide show
  1. package/README.md +1 -2
  2. package/bin/cli.js +343 -5
  3. package/package.json +8 -3
  4. package/src/build-info.json +2 -1
  5. package/src/opencode/ARCHITECTURE.md +7 -6
  6. package/src/opencode/FLOW.yaml +157 -102
  7. package/src/opencode/agents/analyst.md +24 -20
  8. package/src/opencode/agents/architect.md +104 -39
  9. package/src/opencode/agents/change-manager.md +112 -250
  10. package/src/opencode/agents/coder.md +36 -19
  11. package/src/opencode/agents/crawler.md +180 -97
  12. package/src/opencode/agents/dev.md +117 -29
  13. package/src/opencode/agents/pm.md +25 -32
  14. package/src/opencode/agents/researcher.md +116 -241
  15. package/src/opencode/commands/architecture.md +1 -1
  16. package/src/opencode/commands/dev-story.md +1 -5
  17. package/src/opencode/commands/prd.md +1 -1
  18. package/src/opencode/commands/unit-docs.md +170 -0
  19. package/src/opencode/config.yaml +29 -0
  20. package/src/opencode/opencode.json +5 -0
  21. package/src/opencode/skills/adr-writing/SKILL.md +122 -159
  22. package/src/opencode/skills/adr-writing/template.md +130 -0
  23. package/src/opencode/skills/architecture-design/SKILL.md +113 -107
  24. package/src/opencode/skills/architecture-design/template.md +212 -0
  25. package/src/opencode/skills/architecture-validation/SKILL.md +1 -1
  26. package/src/opencode/skills/changelog/template.md +23 -0
  27. package/src/opencode/{workflows/dev-story/instructions.md → skills/dev-story/SKILL.md} +2 -2
  28. package/src/opencode/skills/epic-writing/SKILL.md +116 -264
  29. package/src/opencode/skills/epic-writing/template.md +119 -0
  30. package/src/opencode/skills/prd-validation/SKILL.md +1 -1
  31. package/src/opencode/skills/prd-writing/SKILL.md +79 -43
  32. package/src/opencode/skills/prd-writing/template.md +147 -0
  33. package/src/opencode/skills/requirements-gathering/SKILL.md +128 -78
  34. package/src/opencode/skills/requirements-gathering/template.md +156 -0
  35. package/src/opencode/skills/story-writing/SKILL.md +106 -464
  36. package/src/opencode/skills/story-writing/template.md +214 -0
  37. package/src/opencode/skills/unit-writing/SKILL.md +185 -0
  38. package/src/opencode/skills/unit-writing/template.md +136 -0
  39. package/src/opencode/tools/codeindex.ts +255 -0
  40. package/src/opencode/tools/codesearch.ts +134 -0
  41. package/src/repo-structure/docs/README.md +5 -5
  42. package/src/repo-structure/docs/requirements/README.md +1 -1
  43. package/src/opencode/templates/CHANGELOG.md +0 -82
  44. package/src/opencode/templates/adr-template.md +0 -115
  45. package/src/opencode/templates/architecture-template.md +0 -362
  46. package/src/opencode/templates/epic-template.md +0 -166
  47. package/src/opencode/templates/prd-template.md +0 -479
  48. package/src/opencode/templates/requirements-template.md +0 -132
  49. package/src/opencode/templates/story-template.md +0 -182
  50. /package/src/opencode/{templates/prd-acceptance-criteria-template.md → skills/acceptance-criteria/template.md} +0 -0
  51. /package/src/opencode/{templates/change-proposal-template.md → skills/archiving/template-change-proposal.md} +0 -0
  52. /package/src/opencode/{templates/git-workflow-template.md → skills/coding-standards/template-git.md} +0 -0
  53. /package/src/opencode/{templates/testing-standards-template.md → skills/coding-standards/template-testing.md} +0 -0
  54. /package/src/opencode/{templates/jira-cache-template.yaml → skills/jira-integration/template-cache.yaml} +0 -0
  55. /package/src/opencode/{templates/module-index-template.md → skills/module-documentation/template.md} +0 -0
  56. /package/src/opencode/{templates/sprint-status-template.yaml → skills/sprint-planning/template.yaml} +0 -0
  57. /package/src/opencode/{templates/integration-tests-template.md → skills/test-design/template-integration.md} +0 -0
  58. /package/src/opencode/{templates/module-test-cases-template.md → skills/test-design/template-module.md} +0 -0
@@ -0,0 +1,156 @@
1
+ # {{project}} — Requirements
2
+
3
+ ```yaml
4
+ id: REQ-001
5
+ version: 1.0
6
+ status: draft | approved
7
+ date: {{date}}
8
+ author: {{author}}
9
+ ```
10
+
11
+ ---
12
+
13
+ ## Summary
14
+
15
+ {{project}} addresses the need for {{problem_being_solved}}. The primary users are {{target_users}} who need to {{what_they_need_to_accomplish}}.
16
+
17
+ **Key Outcomes:**
18
+ - {{outcome_1}}
19
+ - {{outcome_2}}
20
+
21
+ <!-- e.g.
22
+ TaskFlow addresses the need for lightweight task management for small remote teams. The primary users are team leads and developers who need to coordinate daily work without heavy project management overhead.
23
+
24
+ **Key Outcomes:**
25
+ - Reduce time spent on task coordination by 50%
26
+ - Provide visibility into team workload
27
+ -->
28
+
29
+ ---
30
+
31
+ ## Stakeholders
32
+
33
+ | Role | Representative | Interest | Influence |
34
+ |------|---------------|----------|-----------|
35
+ | {{role}} | {{name}} | {{what_they_care_about}} | High/Med/Low |
36
+
37
+ ---
38
+
39
+ ## Functional Requirements
40
+
41
+ ### {{Domain_1}}: {{domain_name}}
42
+
43
+ {{brief_context_for_this_group_of_requirements}}
44
+
45
+ | ID | Requirement | Priority | Source |
46
+ |----|-------------|----------|--------|
47
+ | FR-001 | {{user_can_action}} | P0 | {{stakeholder}} |
48
+ | FR-002 | {{user_can_action}} | P0 | {{stakeholder}} |
49
+ | FR-003 | {{system_does_action}} | P1 | {{stakeholder}} |
50
+
51
+ **Business Rules:**
52
+ - {{rule}}
53
+
54
+ **Notes:**
55
+ - {{clarification}}
56
+
57
+ <!-- e.g.
58
+ ### Task Management
59
+
60
+ Core task lifecycle operations that all users need.
61
+
62
+ | ID | Requirement | Priority | Source |
63
+ |----|-------------|----------|--------|
64
+ | FR-001 | User can create task with title (required) and description (optional) | P0 | Team Lead |
65
+ | FR-002 | User can assign task to team member | P0 | Team Lead |
66
+ | FR-003 | System validates title is not empty and under 200 chars | P0 | Tech Lead |
67
+
68
+ **Business Rules:**
69
+ - Task can have only one assignee at a time
70
+ - Title is required, description is optional
71
+
72
+ **Notes:**
73
+ - Assignment notifications handled in FR-010 (Notifications domain)
74
+ -->
75
+
76
+ ### {{Domain_2}}: {{domain_name}}
77
+
78
+ {{brief_context}}
79
+
80
+ | ID | Requirement | Priority | Source |
81
+ |----|-------------|----------|--------|
82
+ | FR-010 | {{requirement}} | P1 | {{stakeholder}} |
83
+
84
+ ---
85
+
86
+ ## Non-Functional Requirements
87
+
88
+ ### Performance
89
+
90
+ | ID | Requirement | Metric | Priority |
91
+ |----|-------------|--------|----------|
92
+ | NFR-001 | {{what}} | {{measurable_target}} | P0 |
93
+
94
+ ### Security
95
+
96
+ | ID | Requirement | Standard/Approach | Priority |
97
+ |----|-------------|-------------------|----------|
98
+ | NFR-010 | {{what}} | {{how}} | P0 |
99
+
100
+ ### Scalability
101
+
102
+ | ID | Requirement | Target | Priority |
103
+ |----|-------------|--------|----------|
104
+ | NFR-020 | {{what}} | {{number}} | P1 |
105
+
106
+ ---
107
+
108
+ ## Constraints
109
+
110
+ | Type | Constraint | Impact |
111
+ |------|------------|--------|
112
+ | Technical | {{constraint}} | {{how_it_affects_solution}} |
113
+ | Business | {{constraint}} | {{how_it_affects_solution}} |
114
+ | Timeline | {{constraint}} | {{what_must_be_true}} |
115
+
116
+ ---
117
+
118
+ ## Assumptions
119
+
120
+ | # | Assumption | Risk if Wrong | Validation |
121
+ |---|------------|---------------|------------|
122
+ | 1 | {{assumption}} | {{impact}} | {{how_to_verify}} |
123
+
124
+ ---
125
+
126
+ ## Dependencies
127
+
128
+ | Dependency | Type | Owner | Status | Risk |
129
+ |------------|------|-------|--------|------|
130
+ | {{system_or_team}} | {{technical/organizational}} | {{who}} | {{status}} | H/M/L |
131
+
132
+ ---
133
+
134
+ ## Open Questions
135
+
136
+ | # | Question | Owner | Due | Status |
137
+ |---|----------|-------|-----|--------|
138
+ | 1 | {{question}} | {{name}} | {{date}} | Open |
139
+
140
+ **Resolved Questions:**
141
+ - Q: {{question}} — A: {{answer}}
142
+
143
+ ---
144
+
145
+ ## Glossary
146
+
147
+ | Term | Definition |
148
+ |------|------------|
149
+ | {{term}} | {{definition}} |
150
+
151
+ ---
152
+
153
+ ## References
154
+
155
+ → PRD: `{{path}}`
156
+ → Stakeholder Interviews: `{{path}}`