Skip to content

Commit e198ccc

Browse files
jawwad-aliclaude
andcommitted
docs: run /speckit.checklist after /speckit.plan in quickstart
The quickstart workflow showed /speckit.checklist before /speckit.plan, contradicting the CLI next-steps text (commands/init.py), which lists the checklist as running after the plan. Per the maintainer on #2816 — "the docs were actually wrong here ... checklists are meant for after plan" — align the docs to the CLI: move /speckit.checklist after /speckit.plan in the workflow diagram, the prose, and both walkthrough step sequences. Docs-only; no behavior change. Closes #2606 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 3c11f4d commit e198ccc

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

docs/quickstart.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
1313
After installing Spec Kit and defining your project constitution, quick experiments can use the lean feature path: `/speckit.specify` -> `/speckit.plan` -> `/speckit.tasks` -> `/speckit.implement`. For production features or any work with meaningful ambiguity, treat `/speckit.clarify`, `/speckit.checklist`, and `/speckit.analyze` as regular quality gates:
1414

1515
```text
16-
/speckit.constitution -> /speckit.specify -> /speckit.clarify -> /speckit.checklist -> /speckit.plan -> /speckit.tasks -> /speckit.analyze -> /speckit.implement
16+
/speckit.constitution -> /speckit.specify -> /speckit.clarify -> /speckit.plan -> /speckit.checklist -> /speckit.tasks -> /speckit.analyze -> /speckit.implement
1717
```
1818

19-
Use `/speckit.clarify` to reduce requirement ambiguity before planning, `/speckit.checklist` to validate requirements quality before planning, and `/speckit.analyze` to check spec/plan/task consistency before implementation starts. You can repeat `/speckit.analyze` after implementation as an extra review, but keep the first analysis before `/speckit.implement` so gaps are caught while the plan and tasks can still be adjusted.
19+
Use `/speckit.clarify` to reduce requirement ambiguity before planning, `/speckit.checklist` to validate requirements quality once the plan exists, and `/speckit.analyze` to check spec/plan/task consistency before implementation starts. You can repeat `/speckit.analyze` after implementation as an extra review, but keep the first analysis before `/speckit.implement` so gaps are caught while the plan and tasks can still be adjusted.
2020

2121
### Step 1: Install Specify
2222

@@ -75,12 +75,6 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
7575
/speckit.clarify Focus on security and performance requirements.
7676
```
7777

78-
Then validate the requirements with `/speckit.checklist` before creating the technical plan:
79-
80-
```bash
81-
/speckit.checklist
82-
```
83-
8478
### Step 5: Create a Technical Implementation Plan
8579

8680
**In the chat**, use the `/speckit.plan` slash command to provide your tech stack and architecture choices.
@@ -89,6 +83,12 @@ Then validate the requirements with `/speckit.checklist` before creating the tec
8983
/speckit.plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.
9084
```
9185

86+
Then validate quality with `/speckit.checklist` once the plan exists:
87+
88+
```bash
89+
/speckit.checklist
90+
```
91+
9292
### Step 6: Break Down, Analyze, and Implement
9393

9494
**In the chat**, use the `/speckit.tasks` slash command to create an actionable task list.
@@ -150,20 +150,20 @@ You can continue to refine the spec with more details using `/speckit.clarify`:
150150
/speckit.clarify When you first launch Taskify, it's going to give you a list of the five users to pick from. There will be no password required. When you click on a user, you go into the main view, which displays the list of projects. When you click on a project, you open the Kanban board for that project. You're going to see the columns. You'll be able to drag and drop cards back and forth between different columns. You will see any cards that are assigned to you, the currently logged in user, in a different color from all the other ones, so you can quickly see yours. You can edit any comments that you make, but you can't edit comments that other people made. You can delete any comments that you made, but you can't delete comments anybody else made.
151151
```
152152
153-
### Step 4: Validate the Spec
153+
### Step 4: Generate Technical Plan with `/speckit.plan`
154154
155-
Validate the specification checklist using the `/speckit.checklist` command:
155+
Be specific about your tech stack and technical requirements:
156156
157157
```bash
158-
/speckit.checklist
158+
/speckit.plan We are going to generate this using .NET Aspire, using Postgres as the database. The frontend should use Blazor server with drag-and-drop task boards, real-time updates. There should be a REST API created with a projects API, tasks API, and a notifications API.
159159
```
160160
161-
### Step 5: Generate Technical Plan with `/speckit.plan`
161+
### Step 5: Validate the Spec
162162
163-
Be specific about your tech stack and technical requirements:
163+
Validate the specification checklist using the `/speckit.checklist` command:
164164
165165
```bash
166-
/speckit.plan We are going to generate this using .NET Aspire, using Postgres as the database. The frontend should use Blazor server with drag-and-drop task boards, real-time updates. There should be a REST API created with a projects API, tasks API, and a notifications API.
166+
/speckit.checklist
167167
```
168168
169169
### Step 6: Define Tasks

0 commit comments

Comments
 (0)