From 6a6b4c6faca09a8b9ecc0b860d8d775a8818e487 Mon Sep 17 00:00:00 2001 From: Justin Parker Date: Thu, 25 Dec 2025 22:02:15 -0800 Subject: [PATCH] naming and prompt cleanup --- src/plan2code-1b--revise-plan.md | 2 +- src/plan2code-2--document.md | 25 ++++++++++--------------- src/plan2code-3--implement.md | 8 ++++---- src/plan2code-4--finalize.md | 12 ++++++------ 4 files changed, 21 insertions(+), 26 deletions(-) diff --git a/src/plan2code-1b--revise-plan.md b/src/plan2code-1b--revise-plan.md index 78e79f5..f436369 100644 --- a/src/plan2code-1b--revise-plan.md +++ b/src/plan2code-1b--revise-plan.md @@ -159,7 +159,7 @@ Report any issues found and resolve before proceeding. 3. Remind user of next steps: -```markdown +``` ╔═══════════════════════════════════════════════════════════════════╗ ║ REVISION COMPLETE ║ ╠═══════════════════════════════════════════════════════════════════╣ diff --git a/src/plan2code-2--document.md b/src/plan2code-2--document.md index ec850fd..e05b8d0 100644 --- a/src/plan2code-2--document.md +++ b/src/plan2code-2--document.md @@ -89,7 +89,7 @@ Each task should be: - Success Criteria checklist (from section 7) - Phase Checklist (from Implementation Phases) - Quick Reference (Key Files, Environment Variables, External Dependencies) -5. **Write** each `Phase X.md` file with detailed tasks +5. **Write** each `phase-X.md` file with detailed tasks 6. **Verify** all requirements from planning document are covered 7. **Present** summary to user and ask about the planning document @@ -101,9 +101,9 @@ Create the following file structure: specs/ └── / ├── overview.md # High-level overview with phase checklist - ├── Phase 1.md # Detailed tasks for Phase 1 - ├── Phase 2.md # Detailed tasks for Phase 2 - └── Phase N.md # Continue for all phases + ├── phase-1.md # Detailed tasks for Phase 1 + ├── phase-2.md # Detailed tasks for Phase 2 + └── phase-N.md # Continue for all phases ``` The `` folder should use kebab-case (e.g., `user-authentication`, `payment-integration`). @@ -185,7 +185,7 @@ Check the Testing Strategy from the PLAN-DRAFT (section 2.4): [Filled in during finalization] ``` -### Phase X.md Template +### phase-X.md Template ```markdown # Phase X: [Descriptive Name] @@ -249,8 +249,8 @@ Once all files are created, present this summary: Created files: - specs//overview.md -- specs//Phase 1.md -- specs//Phase 2.md +- specs//phase-1.md +- specs//phase-2.md [etc.] Total phases: X @@ -259,15 +259,10 @@ Total tasks: Y Requirements coverage: [Confirm all planning requirements are addressed] ``` -Then ask the user: +Then automatically archive the planning document: -> "The planning document `specs/PLAN-DRAFT-.md` has been converted to implementation specs. Would you like to: -> -> 1. **Delete it** - The information is now in the spec files -> 2. **Archive it** - Move to `specs//PLAN-DRAFT.md` for reference -> 3. **Keep it** - Leave in current location -> -> I recommend option 2 for traceability." +1. Move `specs/PLAN-DRAFT-.md` to `specs//PLAN-DRAFT.md` +2. Confirm: "Archived planning document to `specs//PLAN-DRAFT.md` for reference." When documentation is complete, tell the user: diff --git a/src/plan2code-3--implement.md b/src/plan2code-3--implement.md index d259c47..df22af2 100644 --- a/src/plan2code-3--implement.md +++ b/src/plan2code-3--implement.md @@ -32,7 +32,7 @@ If the user provides a path to an `overview.md` file (e.g., `specs/high-severity 1. Read the overview.md file 2. Find the "Phase Checklist" section 3. Identify the first unchecked `[ ]` phase - this is the next phase to implement -4. Automatically read the corresponding `Phase X.md` file from the same directory +4. Automatically read the corresponding `phase-X.md` file from the same directory 5. Proceed with implementation **Option 2: Auto-detect from specs folder** @@ -111,7 +111,7 @@ For each task in the phase: After all tasks are done: -1. Update `Phase X.md`: +1. Update `phase-X.md`: - All task checkboxes marked `[x]` - Fill in the "Phase Completion Summary" section @@ -214,7 +214,7 @@ Before requesting user sign-off, verify: ```markdown ## Implementation Review -- [ ] All tasks in Phase X.md are checked `[x]` or marked blocked `[!]` +- [ ] All tasks in phase-X.md are checked `[x]` or marked blocked `[!]` - [ ] All files mentioned in tasks exist and are properly formatted - [ ] No TODO/FIXME comments left unaddressed in new code - [ ] Code compiles/parses without syntax errors @@ -222,7 +222,7 @@ Before requesting user sign-off, verify: - [ ] Tests executed (if testing tasks present in this phase) - [ ] Test results documented in completion summary - [ ] Blocked tasks (if any) are documented with clear explanations -- [ ] Phase X.md "Phase Completion Summary" section is filled in +- [ ] phase-X.md "Phase Completion Summary" section is filled in - [ ] **READY FOR USER SIGN-OFF** (do NOT update overview.md checkbox yet) ``` diff --git a/src/plan2code-4--finalize.md b/src/plan2code-4--finalize.md index 63ab903..cc439d7 100644 --- a/src/plan2code-4--finalize.md +++ b/src/plan2code-4--finalize.md @@ -29,7 +29,7 @@ If there are multiple active spec folders or nothing was already provided, ask t 1. The entire `specs//` directory contents: - `overview.md` - - All `Phase X.md` files + - All `phase-X.md` files **Do not proceed until you have all spec files.** @@ -71,7 +71,7 @@ Complete these steps in order. Report progress after each step. #### Process: -1. Open each `Phase X.md` file +1. Open each `phase-X.md` file 2. For every task, verify its status: | Status | Meaning | Action Required | @@ -272,8 +272,8 @@ Add this summary to `overview.md` under `## Completion Summary`. 1. Create archive directory: `specs--completed//` 2. Move all files from `specs//` to the archive: - `overview.md` (with completion summary added) - - All `Phase X.md` files - - `PLAN-DRAFT.md` (if it was archived here) + - All `phase-X.md` files + - `PLAN-DRAFT.md` (if present) 3. Verify the original `specs//` directory is empty and can be removed #### Archive structure: @@ -285,8 +285,8 @@ specs/ specs--completed/ └── / # Archived feature ├── overview.md # With completion summary - ├── Phase 1.md # All checkboxes [x] - ├── Phase 2.md + ├── phase-1.md # All checkboxes [x] + ├── phase-2.md └── ... ```