docs: document high-assurance spec workflow#2518
Open
officialasishkumar wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Quick Start documentation to present clarify, checklist, and analyze as standard quality gates for higher-assurance workflows, rather than optional steps.
Changes:
- Reframes the Quick Start workflow as “Recommended Workflow” and adds a high-assurance command sequence.
- Updates the “Break Down and Implement” step to include explicit
/speckit.checklistand/speckit.analyzevalidation prior to/speckit.implement. - Tweaks the “Key Principles” guidance to emphasize validating requirements and plans before coding.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > [!TIP] | ||
| > **Context Awareness**: Spec Kit commands automatically detect the active feature based on your current Git branch (e.g., `001-feature-name`). To switch between different specifications, simply switch Git branches. | ||
|
|
||
| For quick experiments, you can move directly from `specify` to `plan`, `tasks`, and `implement`. For production features or any work with meaningful ambiguity, treat `clarify`, `checklist`, and `analyze` as regular quality gates: |
Comment on lines
+15
to
+17
| ```text | ||
| /speckit.specify -> /speckit.clarify -> /speckit.plan -> /speckit.tasks -> /speckit.checklist -> /speckit.analyze -> /speckit.implement | ||
| ``` |
Comment on lines
+15
to
+19
| ```text | ||
| /speckit.specify -> /speckit.clarify -> /speckit.plan -> /speckit.tasks -> /speckit.checklist -> /speckit.analyze -> /speckit.implement | ||
| ``` | ||
|
|
||
| Use `clarify` to reduce requirement ambiguity before planning, `checklist` to validate requirements quality before implementation, and `analyze` to check spec/plan/task consistency before implementation starts. |
| ``` | ||
|
|
||
| ### Step 6: Break Down and Implement | ||
| ### Step 6: Break Down, Analyze, and Implement |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #2496.
Updates the quickstart guide to present
clarify,checklist, andanalyzeas regular quality gates for production or ambiguity-heavy work. The recommended command path now shows the high-assurance flow before implementation and the task breakdown step now includes checklist and analysis validation before/speckit.implement.Testing
uv run specify --helpuv sync && uv run pytestAdditional validation:
git diff --checknpx markdownlint-cli2 docs/quickstart.mdAI Disclosure
Used AI assistance to inspect repository context, draft the documentation wording, and run local validation; the changes were reviewed before submission.