Skip to content

Commit 10e1f0f

Browse files
committed
docs: clarify sds.implement creates documents NOT code
Added explicit 'NOT code' clarification to prevent misunderstanding: - /metaspec.sds.implement writes specification documents - NOT generating code examples or implementations Previous confusion: Users thought it generates code implementation examples, but it actually creates specification document files (e.g., 002-order.md, 003-payment.md). Updated locations: - README.md: 2 places - AGENTS.md: 3 places - .metaspec/README.md.j2: 1 place This ensures clear understanding that the command creates sub-specification documents, not code files.
1 parent 9580a30 commit 10e1f0f

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ For defining domain specifications:
149149
- `/metaspec.sds.clarify` - Resolve ambiguities in specification
150150
- `/metaspec.sds.plan` - Plan specification architecture and sub-specifications
151151
- `/metaspec.sds.tasks` - Break down specification work
152-
- `/metaspec.sds.implement` - Write specification documents
152+
- `/metaspec.sds.implement` - Write specification documents (creates sub-spec files, NOT code)
153153
- `/metaspec.sds.checklist` - Generate quality checklist for specification
154154
- `/metaspec.sds.analyze` - Check specification consistency
155155

@@ -573,7 +573,7 @@ examples/
573573
/metaspec.sds.specify # 2. Create root specification
574574
/metaspec.sds.plan # 3. Plan sub-specification architecture ⭐
575575
/metaspec.sds.tasks # 4. Break down specification tasks ⭐
576-
/metaspec.sds.implement # 5. Implement sub-specifications
576+
/metaspec.sds.implement # 5. Write sub-specification documents (NOT code)
577577

578578
# Quality Assurance (Recommended)
579579
/metaspec.sds.checklist # 6. Generate quality checklist
@@ -656,7 +656,7 @@ cd my-speckit
656656
/metaspec.sds.specify "Define MCP specification" # Create root specification
657657
/metaspec.sds.plan # Plan sub-specification architecture
658658
/metaspec.sds.tasks # Break down specification tasks
659-
/metaspec.sds.implement # Implement sub-specifications
659+
/metaspec.sds.implement # Write sub-specification documents (NOT code)
660660
/metaspec.sds.checklist # Quality check (recommended)
661661
/metaspec.sds.analyze # Consistency check (recommended)
662662

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ cd my-spec-kit
289289
# /metaspec.sds.specify - Define specification entities and operations (required)
290290
# /metaspec.sds.plan - Plan specification architecture (if complex) ⭐
291291
# /metaspec.sds.tasks - Break down specification work (if complex) ⭐
292-
# /metaspec.sds.implement - Write specification documents (if complex) ⭐
292+
# /metaspec.sds.implement - Write specification documents, NOT code (if complex) ⭐
293293
# /metaspec.sds.checklist - Generate quality checklist (recommended)
294294
# /metaspec.sds.analyze - Check specification consistency (recommended)
295295
# /metaspec.sds.clarify - Resolve specification ambiguities (optional, on-demand)
@@ -389,7 +389,7 @@ pip install -e .
389389
# If complex (splitting needed):
390390
# /metaspec.sds.plan - Plan specification architecture ⭐
391391
# /metaspec.sds.tasks - Break down specification work ⭐
392-
# /metaspec.sds.implement - Write specification documents ⭐
392+
# /metaspec.sds.implement - Write specification documents (NOT code)
393393
#
394394
# Quality (recommended):
395395
# /metaspec.sds.checklist - Generate quality checklist

src/metaspec/templates/base/.metaspec/README.md.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Manage specification changes:
8686
/metaspec.sds.specify # 2. Define root specification
8787
/metaspec.sds.plan # 3. Plan sub-specification architecture
8888
/metaspec.sds.tasks # 4. Break down specification tasks
89-
/metaspec.sds.implement # 5. Implement sub-specifications
89+
/metaspec.sds.implement # 5. Write sub-specification documents (NOT code)
9090

9191
# Quality Assurance (Recommended)
9292
/metaspec.sds.checklist # 6. Generate quality checklist

0 commit comments

Comments
 (0)