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
+24-7Lines changed: 24 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,19 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
5
5
> [!NOTE]
6
6
> All automation scripts now provide both Bash (`.sh`) and PowerShell (`.ps1`) variants. The `specify` CLI auto-selects based on OS unless you pass `--script sh|ps`.
7
7
8
-
## The 6-Step Process
8
+
## Recommended Workflow
9
9
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
+
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:
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.
20
+
13
21
### Step 1: Install Specify
14
22
15
23
**In your terminal**, run the `specify` CLI command to initialize your project:
/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.
57
68
```
58
69
59
-
### Step 4: Refine the Spec
70
+
### Step 4: Refine and Validate the Spec
60
71
61
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.
62
73
63
74
```bash
64
75
/speckit.clarify Focus on security and performance requirements.
65
76
```
66
77
78
+
Then validate the requirements with `/speckit.checklist` before creating the technical plan:
79
+
80
+
```bash
81
+
/speckit.checklist
82
+
```
83
+
67
84
### Step 5: Create a Technical Implementation Plan
68
85
69
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.
73
90
```
74
91
75
-
### Step 6: Break Down and Implement
92
+
### Step 6: Break Down, Analyze, and Implement
76
93
77
94
**In the chat**, use the `/speckit.tasks` slash command to create an actionable task list.
78
95
79
96
```markdown
80
97
/speckit.tasks
81
98
```
82
99
83
-
Optionally, validate the plan with `/speckit.analyze`:
100
+
Validate cross-artifact consistency with `/speckit.analyze` before implementation:
84
101
85
102
```markdown
86
103
/speckit.analyze
87
104
```
88
105
89
-
Then, use the `/speckit.implement` slash command to execute the plan.
106
+
Use the `/speckit.implement` slash command to execute the plan.
90
107
91
108
```markdown
92
109
/speckit.implement
@@ -159,7 +176,7 @@ Generate an actionable task list using the `/speckit.tasks` command:
159
176
160
177
### Step 7: Validate and Implement
161
178
162
-
Have your coding agent audit the implementation plan using `/speckit.analyze`:
179
+
Have your coding agent audit the spec, plan, and tasks with `/speckit.analyze` before implementation:
163
180
164
181
```bash
165
182
/speckit.analyze
@@ -179,7 +196,7 @@ Finally, implement the solution:
179
196
- **Be explicit** about what you're building and why
180
197
- **Don't focus on tech stack** during specification phase
181
198
- **Iterate and refine** your specifications before implementation
182
-
- **Validate** the plan before coding begins
199
+
- **Validate** requirements and plans before coding begins
183
200
- **Let the coding agent handle** the implementation details
0 commit comments