Skip to content

Commit fc0d798

Browse files
authored
fix: clarify spec naming convention and task checkbox format (Fission-AI#595)
* fix: clarify spec naming convention and task checkbox format - Update docs, schema, and templates to clarify that specs should be named after capabilities (specs/<capability>/spec.md), not changes - Emphasize that tasks MUST use checkbox format for apply phase tracking * fix: clarify delta spec location for modified capabilities Address review feedback: explicitly state that the delta spec is created at specs/<capability>/spec.md, not in openspec/specs/<capability>/.
1 parent d155126 commit fc0d798

3 files changed

Lines changed: 11 additions & 6 deletions

File tree

docs/opsx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ Artifacts form a directed acyclic graph (DAG). Dependencies are **enablers**, no
457457
│ • Create proposal.md │
458458
│ • Create tasks.md │
459459
│ • Create design.md │
460-
│ • Create specs/*.md
460+
│ • Create specs/<capability>/spec.md │
461461
│ │
462462
│ No awareness of what exists or │
463463
│ dependencies between artifacts │

schemas/spec-driven/schema.yaml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ artifacts:
3434
instruction: |
3535
Create specification files that define WHAT the system should do.
3636
37-
Create one spec file per capability/feature area in specs/<name>/spec.md.
37+
Create one spec file per capability listed in the proposal's Capabilities section.
38+
- New capabilities: use the exact kebab-case name from the proposal (specs/<capability>/spec.md).
39+
- Modified capabilities: use the existing spec folder name from openspec/specs/<capability>/ when creating the delta spec at specs/<capability>/spec.md.
3840
3941
Delta operations (use ## headers):
4042
- **ADDED Requirements**: New capabilities
@@ -110,14 +112,17 @@ artifacts:
110112

111113
- id: tasks
112114
generates: tasks.md
113-
description: Implementation tasks derived from specs and design
115+
description: Implementation checklist with trackable tasks
114116
template: tasks.md
115117
instruction: |
116118
Create the task list that breaks down the implementation work.
117119
120+
**IMPORTANT: Follow the template below exactly.** The apply phase parses
121+
checkbox format to track progress. Tasks not using `- [ ]` won't be tracked.
122+
118123
Guidelines:
119124
- Group related tasks under ## numbered headings
120-
- Each task is a checkbox: - [ ] X.Y Task description
125+
- Each task MUST be a checkbox: `- [ ] X.Y Task description`
121126
- Tasks should be small enough to complete in one session
122127
- Order tasks by dependency (what must be done first?)
123128

src/core/templates/skill-templates.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ Common artifact patterns:
486486
**spec-driven schema** (proposal → specs → design → tasks):
487487
- **proposal.md**: Ask user about the change if not clear. Fill in Why, What Changes, Capabilities, Impact.
488488
- The Capabilities section is critical - each capability listed will need a spec file.
489-
- **specs/*.md**: Create one spec per capability listed in the proposal.
489+
- **specs/<capability>/spec.md**: Create one spec per capability listed in the proposal's Capabilities section (use the capability name, not the change name).
490490
- **design.md**: Document technical decisions, architecture, and implementation approach.
491491
- **tasks.md**: Break down implementation into checkboxed tasks.
492492
@@ -1817,7 +1817,7 @@ Common artifact patterns:
18171817
**spec-driven schema** (proposal → specs → design → tasks):
18181818
- **proposal.md**: Ask user about the change if not clear. Fill in Why, What Changes, Capabilities, Impact.
18191819
- The Capabilities section is critical - each capability listed will need a spec file.
1820-
- **specs/*.md**: Create one spec per capability listed in the proposal.
1820+
- **specs/<capability>/spec.md**: Create one spec per capability listed in the proposal's Capabilities section (use the capability name, not the change name).
18211821
- **design.md**: Document technical decisions, architecture, and implementation approach.
18221822
- **tasks.md**: Break down implementation into checkboxed tasks.
18231823

0 commit comments

Comments
 (0)