Skip to content

Commit 6220cc8

Browse files
docs: align high-assurance workflow gates
1 parent 1f420eb commit 6220cc8

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

docs/quickstart.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
1010
> [!TIP]
1111
> **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.
1212
13-
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:
13+
For quick experiments, you can move directly from `/speckit.specify` to `/speckit.plan`, `/speckit.tasks`, and `/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.specify -> /speckit.clarify -> /speckit.plan -> /speckit.tasks -> /speckit.checklist -> /speckit.analyze -> /speckit.implement
16+
/speckit.specify -> /speckit.clarify -> /speckit.checklist -> /speckit.plan -> /speckit.tasks -> /speckit.implement -> /speckit.analyze
1717
```
1818

19-
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.
19+
Use `/speckit.clarify` to reduce requirement ambiguity before planning, `/speckit.checklist` to validate requirements quality before planning, and `/speckit.analyze` as a final consistency check after implementation.
2020

2121
### Step 1: Install Specify
2222

@@ -67,14 +67,20 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
6767
/speckit.specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.
6868
```
6969

70-
### Step 4: Refine the Spec
70+
### Step 4: Refine and Validate the Spec
7171

7272
**In the chat**, use the `/speckit.clarify` slash command to identify and resolve ambiguities in your specification. You can provide specific focus areas as arguments.
7373

7474
```bash
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+
7884
### Step 5: Create a Technical Implementation Plan
7985

8086
**In the chat**, use the `/speckit.plan` slash command to provide your tech stack and architecture choices.
@@ -83,30 +89,24 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
8389
/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.
8490
```
8591

86-
### Step 6: Break Down, Analyze, and Implement
92+
### Step 6: Break Down, Implement, and Analyze
8793

8894
**In the chat**, use the `/speckit.tasks` slash command to create an actionable task list.
8995

9096
```markdown
9197
/speckit.tasks
9298
```
9399

94-
Validate the requirements with `/speckit.checklist`:
95-
96-
```bash
97-
/speckit.checklist
98-
```
99-
100-
Validate cross-artifact consistency with `/speckit.analyze` before implementation:
100+
Use the `/speckit.implement` slash command to execute the plan.
101101

102102
```markdown
103-
/speckit.analyze
103+
/speckit.implement
104104
```
105105

106-
Then, use the `/speckit.implement` slash command to execute the plan.
106+
After implementation, use `/speckit.analyze` as a final consistency check:
107107

108108
```markdown
109-
/speckit.implement
109+
/speckit.analyze
110110
```
111111

112112
> [!TIP]
@@ -174,18 +174,18 @@ Generate an actionable task list using the `/speckit.tasks` command:
174174
/speckit.tasks
175175
```
176176
177-
### Step 7: Validate and Implement
177+
### Step 7: Implement and Analyze
178178
179-
Have your coding agent audit the implementation plan using `/speckit.analyze`:
179+
Finally, implement the solution:
180180
181181
```bash
182-
/speckit.analyze
182+
/speckit.implement
183183
```
184184
185-
Finally, implement the solution:
185+
Then use `/speckit.analyze` as the final quality gate:
186186
187187
```bash
188-
/speckit.implement
188+
/speckit.analyze
189189
```
190190
191191
> [!TIP]

0 commit comments

Comments
 (0)