You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
10
10
> [!TIP]
11
11
> **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.
12
12
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:
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.
/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.
68
68
```
69
69
70
-
### Step 4: Refine the Spec
70
+
### Step 4: Refine and Validate the Spec
71
71
72
72
**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.
73
73
74
74
```bash
75
75
/speckit.clarify Focus on security and performance requirements.
76
76
```
77
77
78
+
Then validate the requirements with `/speckit.checklist` before creating the technical plan:
79
+
80
+
```bash
81
+
/speckit.checklist
82
+
```
83
+
78
84
### Step 5: Create a Technical Implementation Plan
79
85
80
86
**In the chat**, use the `/speckit.plan` slash command to provide your tech stack and architecture choices.
/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.
84
90
```
85
91
86
-
### Step 6: Break Down, Analyze, and Implement
92
+
### Step 6: Break Down, Implement, and Analyze
87
93
88
94
**In the chat**, use the `/speckit.tasks` slash command to create an actionable task list.
89
95
90
96
```markdown
91
97
/speckit.tasks
92
98
```
93
99
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.
101
101
102
102
```markdown
103
-
/speckit.analyze
103
+
/speckit.implement
104
104
```
105
105
106
-
Then, use the `/speckit.implement` slash command to execute the plan.
106
+
After implementation, use `/speckit.analyze` as a final consistency check:
107
107
108
108
```markdown
109
-
/speckit.implement
109
+
/speckit.analyze
110
110
```
111
111
112
112
> [!TIP]
@@ -174,18 +174,18 @@ Generate an actionable task list using the `/speckit.tasks` command:
174
174
/speckit.tasks
175
175
```
176
176
177
-
### Step 7: Validate and Implement
177
+
### Step 7: Implement and Analyze
178
178
179
-
Have your coding agent audit the implementation plan using `/speckit.analyze`:
179
+
Finally, implement the solution:
180
180
181
181
```bash
182
-
/speckit.analyze
182
+
/speckit.implement
183
183
```
184
184
185
-
Finally, implement the solution:
185
+
Then use `/speckit.analyze` as the final quality gate:
0 commit comments