Skip to content

Commit 1f420eb

Browse files
docs: document high-assurance spec workflow
1 parent 31a0610 commit 1f420eb

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

docs/quickstart.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,19 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
55
> [!NOTE]
66
> 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`.
77
8-
## The 6-Step Process
8+
## Recommended Workflow
99

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:
14+
15+
```text
16+
/speckit.specify -> /speckit.clarify -> /speckit.plan -> /speckit.tasks -> /speckit.checklist -> /speckit.analyze -> /speckit.implement
17+
```
18+
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.
20+
1321
### Step 1: Install Specify
1422

1523
**In your terminal**, run the `specify` CLI command to initialize your project:
@@ -24,10 +32,13 @@ uvx --from git+https://github.com/github/spec-kit.git specify init .
2432

2533
> [!NOTE]
2634
> You can also install the CLI persistently with `pipx`:
35+
>
2736
> ```bash
2837
> pipx install git+https://github.com/github/spec-kit.git
2938
> ```
39+
>
3040
> After installing with `pipx`, run `specify` directly instead of `uvx --from ... specify`, for example:
41+
>
3142
> ```bash
3243
> specify init <PROJECT_NAME>
3344
> specify init .
@@ -72,15 +83,21 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
7283
/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.
7384
```
7485

75-
### Step 6: Break Down and Implement
86+
### Step 6: Break Down, Analyze, and Implement
7687

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

7990
```markdown
8091
/speckit.tasks
8192
```
8293

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:
84101

85102
```markdown
86103
/speckit.analyze
@@ -179,7 +196,7 @@ Finally, implement the solution:
179196
- **Be explicit** about what you're building and why
180197
- **Don't focus on tech stack** during specification phase
181198
- **Iterate and refine** your specifications before implementation
182-
- **Validate** the plan before coding begins
199+
- **Validate** requirements and plans before coding begins
183200
- **Let the coding agent handle** the implementation details
184201
185202
## Next Steps

0 commit comments

Comments
 (0)