Skip to content

Commit 67c3c15

Browse files
committed
docs: Clarify Workflow Specification is still required in SDS (v0.7.3)
Important clarification for v0.7.3: - Specification Operations ≠ Workflow Specification - Even if Operations empty, Workflow Specification REQUIRED - Workflow describes user journey (v0.7.0) - Operations describe API interfaces (optional) This prevents confusion that v0.7.3 removed ALL operations from SDS.
1 parent 49a636b commit 67c3c15

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,29 @@ Operations:
8181

8282
**Key principle**: Most domains don't need Specification Operations. This is specifically for API/Protocol specifications.
8383

84+
### ⚠️ Important Clarification
85+
86+
**This fix is ONLY about "Specification Operations"**. Domain Specs still MUST include:
87+
88+
✅ **Workflow Specification** (v0.7.0 requirement):
89+
```yaml
90+
user_workflows:
91+
- name: Marketing Workflow
92+
phases:
93+
- Discover: Research market needs
94+
- Strategy: Plan campaigns
95+
- Design: Create content
96+
- Execute: Launch campaigns
97+
- Analyze: Measure results
98+
```
99+
100+
This describes **how users use the specification**, not API interfaces or toolkit commands.
101+
102+
**Summary**:
103+
- ✅ **Keep**: Workflow Specification (describes user workflow)
104+
- ⚠️ **Conditional**: Specification Operations (only for API specs)
105+
- ❌ **Remove**: Toolkit Commands (belongs in SDD)
106+
84107
### Impact
85108

86109
**Before this fix**:

src/metaspec/templates/meta/sds/commands/specify.md.j2

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,12 +193,19 @@ ls specs/domain/ | grep -E '^[0-9]{3}-' | sort -n
193193
**Key distinction**:
194194
- **Specification Operations** (SDS) = Interfaces the specification defines (e.g., API endpoints)
195195
- **Toolkit Commands** (SDD) = Commands your toolkit provides (e.g., `/domainspec.discover`)
196+
- **Workflow Specification** (SDS) = How users use the specification (REQUIRED, see v0.7.0)
196197
- These are completely different! Most domains don't need Specification Operations.
198+
199+
**⚠️ Don't confuse**:
200+
- Specification Operations ≠ Workflow Specification
201+
- Even if you leave Operations empty, you MUST still define Workflow Specification
202+
- Workflow describes user journey, Operations describe API interfaces
197203

198204
**Important Notes**:
199205
- This is SDS (Spec-Driven Specification) - focus on specification definition only
200206
- Do NOT include implementation details (Parser, Validator, CLI)
201207
- Do NOT define toolkit commands here - use `/metaspec.sdd.specify` for that
208+
- You MUST define Workflow Specification (see v0.7.0 Workflow Completeness principle)
202209
- For toolkit development, use `/metaspec.sdd.specify` instead
203210

204211
**If user input is vague**, make informed guesses based on domain standards and document assumptions.

0 commit comments

Comments
 (0)