feat(prompts): harden SDD planning, clarification, and review workflows#50
feat(prompts): harden SDD planning, clarification, and review workflows#50ryderstorm wants to merge 11 commits intomainfrom
Conversation
6012d97 to
3b0cda6
Compare
| ## Step 4: Clarification Sufficiency Check | ||
|
|
||
| Ask clarifying questions to gather sufficient detail. Focus on understanding the "what" and "why" rather than the "how." | ||
| Assess whether you already have enough aligned context to write a high-quality spec without inventing requirements. Always err on the side of caution, but do not force a questions file when the available information is already sufficient. |
There was a problem hiding this comment.
I wonder if we're leaning towards giving it too much freedom in this instance here; I reflect on when my AI ignored all my skills because it felt it could do it better and even called itself "overconfident".
I would almost prefer that it ask some clarifying questions about approach but mark what it thinks we want, and that could potentially introduce other methods we weren't aware of to the development process.
I can't count the amount of times I was on client and SDD asked me some questions, and I actually had to pull up with the team to discuss the approach because I hadn't considered the other options.
There was a problem hiding this comment.
Adding on to this -- that being said maybe that can be up to the writer to include that in their prompt when generating the SDD. This could be the default, but if you want to hear different design choices you can ask for that.
There was a problem hiding this comment.
This is a great callout, and your example is an important use case.
In my practice with these changes, i've seen it ask questions when i've given it very little to start with, and avoid it when things are good enough already. I've been pleased with the results so far, it's giving the right level of interaction. Let me know if you think it needs some tweaking after you've run it through a few times.
| Follow this format exactly when you create the questions file. | ||
| Follow this format exactly when you create a questions file. | ||
|
|
||
| Each question MUST include recommended answer guidance for the user. Recommendations should reduce ambiguity, explain tradeoffs, and bias toward the option that best supports a clear, reviewable, junior-friendly spec. |
There was a problem hiding this comment.
I'd almost want it to provide some reading material as well to speed up the decision making process if you're unfamiliar with the material.
There was a problem hiding this comment.
interesting idea! i worry that leans too much into using SDD to just build anything, tho - the user should have some familiarity with what they're trying to build. SDD is designed for inputs that are already groomed, at least a little.
There was a problem hiding this comment.
Yeah it was mostly the "junior-friendly spec" portion that brought this thought to me. In my mind part of Juniors job is learning more about what's being done, so helping with that process would be a part of making it "junior-friendly"
3b0cda6 to
147db0c
Compare
Enforce planning audit gates between task generation and implementation so required planning defects are blocked before execution begins. Add audit-aware auto-selection and planning-resume behavior so existing specs with tasks can continue through audit/remediation without unwanted task regeneration. Co-Authored-By: GPT-5 Codex <no-reply@example.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify that SDD-2 now includes a mandatory planning audit checkpoint with human-approved remediation before implementation handoff. Update README workflow and artifact outputs, and extend FAQ with planning-quality and remediation behavior details. Co-Authored-By: GPT-5 Codex <no-reply@example.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Improve SDD-2 audit readability by defaulting to compact Gateboard and exception-only reporting, with delta-focused re-audit output for faster human review cycles. Add a deterministic reset recommendation gate that triggers restart vs remediation decisions when planning debt exceeds defined thresholds. Co-Authored-By: GPT-5 Codex <no-reply@example.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Add explicit standards-discovery and evidence checkpoints so repository guidance files are consistently read before audit decisions. Introduce a required chain-of-verification step before implementation handoff and define failure handling for missing standards artifacts. Keep audit output compact with a required standards evidence table and minimal pass-case reporting.
Introduce tiered Gate D rules to distinguish blocker-level core file drift from non-blocking supporting-file linkage gaps. Clarify file integrity expectations across gates, detailed checks, red flags, and report examples to improve validation consistency and traceability. Co-Authored-By: Codex <no-reply@example.com>
Clarify spec-generation review flow by nesting the cross-domain guard under Step 6 and replacing undefined terminology with context-aware wording. Improve validation guidance with explicit evidence quality and artifact sufficiency checks, and add a direct GATE D linkage clarification reference. Co-Authored-By: Codex <no-reply@example.com>
Allow SDD-1 to skip questions files when context is already sufficient by requiring an explicit clarification sufficiency check before spec generation. Add recommended-answer guidance to generated questions files so users get direction and tradeoff notes when clarification is needed. Co-Authored-By: OpenCode <no-reply@example.com>
Require SDD-1 to research current best practices for material technologies so specs are informed by modern guidance as well as repository patterns. Route technology-driven ambiguity through the questions file flow, including best-practice context and user confirmation when current guidance leaves meaningful implementation choices open. Co-Authored-By: OpenCode <no-reply@example.com>
Require SDD-3 proof files to lead with reviewer-friendly summaries, per-artifact context, and inline screenshots so humans can validate work faster. Teach SDD-4 to treat sparse proof formatting as an evidence-quality issue by checking for descriptive titles, front-loaded context, and inline image presentation. Co-Authored-By: OpenCode <no-reply@example.com>
Update SDD-2 so generated task files present the Relevant Files section as a markdown table instead of a bullet list. This makes planned file coverage easier to scan during task review without changing the underlying workflow. Co-Authored-By: OpenCode <no-reply@example.com>
147db0c to
024cd5d
Compare
Replace the non-dictionary Gateboard label in the SDD-2 prompt so the repository spell-check gate passes cleanly. This keeps the audit instructions readable while aligning with CI lint rules. Co-Authored-By: AI Assistant <no-reply@example.com>
| Before task generation or audit, locate and read repository guidance files. | ||
|
|
||
| Required search targets (if present): | ||
|
|
There was a problem hiding this comment.
I know AGENTS.md is becoming the standard, but is it worth still including CLAUDE.md for now as well?
There was a problem hiding this comment.
good call! this section is a little too strict, too. It should start with something like
Examples of required search targets (if present):
There was a problem hiding this comment.
FWIW mine still found CLAUDE.md and some other files like .gitlab-ci.yml that weren't explicitly listed! It noted that AGENTS.md was not in the repository, but didn't fail because of that
Summary
This branch significantly strengthens the prompt-driven workflow across planning, spec generation, implementation evidence, and validation. The net effect is a more opinionated and reviewable SDD loop that blocks weak planning earlier, asks fewer unnecessary questions during spec generation, and produces artifacts that are easier for humans to inspect.
What changed
1. Add a mandatory planning-audit checkpoint in SDD-2
2. Make planning audit decisions more reliable
3. Improve SDD-1 spec generation and clarification behavior
4. Ground specs in current external guidance, not just repo patterns
5. Improve task and proof artifact review UX
Relevant Filessection from a bullet list to a markdown table for easier scanability6. Strengthen validation semantics in SDD-4
7. Update docs to match the new workflow
README.mdto describe the audit-first planning flow, conditional questions files, current-standards grounding, and generated artifact setdocs/faq.mdwith planning-audit/remediation behavior so the docs tell the same story as the promptsWhy this matters
Before this branch, the workflow was easier to move through quickly, but it also allowed weak planning handoffs, over-eager question generation, and proof artifacts that were technically present but slow for humans to validate. These changes push the workflow toward:
Files changed
README.mddocs/faq.mdprompts/SDD-1-generate-spec.mdprompts/SDD-2-generate-task-list-from-spec.mdprompts/SDD-3-manage-tasks.mdprompts/SDD-4-validate-spec-implementation.mdValidation
This is a prompt/docs-only branch. Validation focused on prompt/doc linting and consistency checks.
pre-commit run --files "prompts/SDD-1-generate-spec.md" "README.md"pre-commit run --files "prompts/SDD-3-manage-tasks.md" "prompts/SDD-4-validate-spec-implementation.md"pre-commit run --files "prompts/SDD-2-generate-task-list-from-spec.md"Reviewer notes