Skip to content

Commit 41a9fc8

Browse files
committed
docs: add constitution step to quickstart guide (fixes #906)
1 parent f205fa3 commit 41a9fc8

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

docs/quickstart.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
44

55
> NEW: 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`.
66
7-
## The 4-Step Process
7+
## The 5-Step Process
88

99
### 1. Install Specify
1010

@@ -21,31 +21,47 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
2121
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> --script sh # Force POSIX shell
2222
```
2323

24-
### 2. Create the Spec
24+
### 2. Define Your Constitution
25+
26+
Use the `/speckit.constitution` command to establish the core rules and principles for your project. This ensures all future code and specifications adhere to your project's standards.
27+
28+
```bash
29+
/speckit.constitution
30+
```
31+
32+
### 3. Create the Spec
2533

2634
Use the `/speckit.specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
2735

2836
```bash
2937
/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.
3038
```
3139

32-
### 3. Create a Technical Implementation Plan
40+
### 4. Create a Technical Implementation Plan
3341

3442
Use the `/speckit.plan` command to provide your tech stack and architecture choices.
3543

3644
```bash
3745
/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.
3846
```
3947

40-
### 4. Break Down and Implement
48+
### 5. Break Down and Implement
4149

4250
Use `/speckit.tasks` to create an actionable task list, then ask your agent to implement the feature.
4351

4452
## Detailed Example: Building Taskify
4553

4654
Here's a complete example of building a team productivity platform:
4755

48-
### Step 1: Define Requirements with `/speckit.specify`
56+
### Step 1: Define Constitution
57+
58+
Initialize the project's constitution to set ground rules:
59+
60+
```bash
61+
/speckit.constitution
62+
```
63+
64+
### Step 2: Define Requirements with `/speckit.specify`
4965

5066
```text
5167
Develop Taskify, a team productivity platform. It should allow users to create projects, add team members,
@@ -66,7 +82,7 @@ see yours. You can edit any comments that you make, but you can't edit comments
6682
delete any comments that you made, but you can't delete comments anybody else made.
6783
```
6884

69-
### Step 2: Refine the Specification
85+
### Step 3: Refine the Specification
7086

7187
After the initial specification is created, clarify any missing requirements:
7288

@@ -82,7 +98,7 @@ Also validate the specification checklist:
8298
Read the review and acceptance checklist, and check off each item in the checklist if the feature spec meets the criteria. Leave it empty if it does not.
8399
```
84100

85-
### Step 3: Generate Technical Plan with `/speckit.plan`
101+
### Step 4: Generate Technical Plan with `/speckit.plan`
86102

87103
Be specific about your tech stack and technical requirements:
88104

@@ -92,7 +108,7 @@ Blazor server with drag-and-drop task boards, real-time updates. There should be
92108
tasks API, and a notifications API.
93109
```
94110

95-
### Step 4: Validate and Implement
111+
### Step 5: Validate and Implement
96112

97113
Have your AI agent audit the implementation plan:
98114

0 commit comments

Comments
 (0)