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
+21-4Lines changed: 21 additions & 4 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
+
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:
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.
20
+
13
21
### Step 1: Install Specify
14
22
15
23
**In your terminal**, run the `specify` CLI command to initialize your project:
/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
84
```
74
85
75
-
### Step 6: Break Down and Implement
86
+
### Step 6: Break Down, Analyze, and Implement
76
87
77
88
**In the chat**, use the `/speckit.tasks` slash command to create an actionable task list.
78
89
79
90
```markdown
80
91
/speckit.tasks
81
92
```
82
93
83
-
Optionally, validate the plan with `/speckit.analyze`:
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:
84
101
85
102
```markdown
86
103
/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