Skip to content

Commit cdda5e5

Browse files
committed
fix: address additional PR review feedback - placeholder consistency and grammar
- Fix remaining [n] → [NN] placeholder inconsistencies in generate-spec.md and generate-task-list-from-spec.md - Fix grammar: 'top level' → 'top-level' in archive document - Fix capitalization: 'markdown' → 'Markdown' as proper noun - All quality gates pass: pre-commit hooks, tests (79/85%), and linting
1 parent c914184 commit cdda5e5

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/archive/refactor-sdd-workflow-prompts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Based on prompt engineering best practices for spec-driven development, the work
4242
**generate-task-list-from-spec.md:**
4343

4444
- Add explanation of why parent tasks are generated first
45-
- Add guidance on how to evaluate top level tasks against the spec
45+
- Add guidance on how to evaluate top-level tasks against the spec
4646
- Enhance the "Generate sub tasks" interaction with clearer context
4747
- Add "DO NOT generate sub-tasks until explicitly requested" constraint
4848
- Add clear guidance on "What happens next" section after task generation, including when to move to task implementation and how to do it
@@ -134,7 +134,7 @@ All specs, tasks, and proofs should be stored in `./docs/specs`. Simple director
134134
- **Co-located artifacts**: Proofs are organized by task number within each spec
135135
- **Team-managed lifecycle**: Teams determine when to archive specs, tasks, and proofs as they see fit
136136
- **Clear traceability**: Easy to see which proofs belong to which tasks and specs
137-
- **Consistent naming**: Proof artifacts follow single markdown file pattern `[spec]-[task]-proofs.md` containing all evidence as markdown code blocks
137+
- **Consistent naming**: Proof artifacts follow single Markdown file pattern `[spec]-[task]-proofs.md` containing all evidence as Markdown code blocks
138138

139139
### Simplify numbering system
140140

prompts/generate-spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ Follow this exact sequence:
289289
- **Demoable Units** focus on tangible progress and WHAT will be shown
290290
- **Functional Requirements** focus on system behavior and WHAT the system must do
291291
- **Technical Considerations** focus on implementation constraints and HOW it will be built
292-
5. **Save**: Create directory `./docs/specs/[n]-spec-[feature-name]/` and save file as `[n]-spec-[feature-name].md` inside it
292+
5. **Save**: Create directory `./docs/specs/[NN]-spec-[feature-name]/` and save file as `[NN]-spec-[feature-name].md` inside it
293293
6. **Review and Refine**: Validate completeness and clarity with the user
294294
7. **Guide User**: Direct user to the next workflow step (`/generate-task-list-from-spec`)
295295
8. **Stop**: Stop working once user confirms spec is complete

prompts/generate-task-list-from-spec.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Before generating any tasks, you must follow this reasoning process:
103103

104104
### Phase 1: Analysis and Planning (Internal)
105105

106-
1. **Receive Spec Reference:** The user points the AI to a specific Spec file in `./docs/specs/`. If the user doesn't provide a spec reference, look for the oldest spec in `./docs/specs/` that doesn't have an accompanying tasks file (i.e., no `[n]-tasks-[feature-name].md` file in the same directory).
106+
1. **Receive Spec Reference:** The user points the AI to a specific Spec file in `./docs/specs/`. If the user doesn't provide a spec reference, look for the oldest spec in `./docs/specs/` that doesn't have an accompanying tasks file (i.e., no `[NN]-tasks-[feature-name].md` file in the same directory).
107107
2. **Analyze Spec:** Read and analyze the functional requirements, user stories, and technical constraints
108108
3. **Assess Current State:** Review existing codebase and documentation to understand:
109109
- Architectural patterns and conventions
@@ -122,7 +122,7 @@ Before generating any tasks, you must follow this reasoning process:
122122
- Have clear completion criteria
123123
- Follow logical dependencies
124124
- Be implementable in a reasonable timeframe
125-
2. **Save Initial Task List:** Save the parent tasks to `./docs/specs/[n]-spec-[feature-name]/[n]-tasks-[feature-name].md` before proceeding
125+
2. **Save Initial Task List:** Save the parent tasks to `./docs/specs/[NN]-spec-[feature-name]/[NN]-tasks-[feature-name].md` before proceeding
126126
3. **Present for Review**: Present the generated parent tasks to the user for review and wait for their response
127127
4. **Wait for Confirmation**: Pause and wait for user to respond with "Generate sub tasks"
128128

@@ -132,7 +132,7 @@ Wait for explicit user confirmation before generating sub-tasks. Then:
132132

133133
1. **Identify Relevant Files:** List all files that will need creation or modification
134134
2. **Generate Sub-Tasks:** Break down each parent task into smaller, actionable sub-tasks
135-
3. **Update Task List:** Update the existing `./docs/specs/[n]-spec-[feature-name]/[n]-tasks-[feature-name].md` file with the sub-tasks and relevant files sections
135+
3. **Update Task List:** Update the existing `./docs/specs/[NN]-spec-[feature-name]/[NN]-tasks-[feature-name].md` file with the sub-tasks and relevant files sections
136136

137137
## Phase 2 Output Format (Parent Tasks Only)
138138

0 commit comments

Comments
 (0)