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-8Lines changed: 24 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
4
4
5
5
> 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`.
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> --script sh # Force POSIX shell
22
22
```
23
23
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
25
33
26
34
Use the `/speckit.specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
27
35
28
36
```bash
29
37
/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.
30
38
```
31
39
32
-
### 3. Create a Technical Implementation Plan
40
+
### 4. Create a Technical Implementation Plan
33
41
34
42
Use the `/speckit.plan` command to provide your tech stack and architecture choices.
35
43
36
44
```bash
37
45
/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.
38
46
```
39
47
40
-
### 4. Break Down and Implement
48
+
### 5. Break Down and Implement
41
49
42
50
Use `/speckit.tasks` to create an actionable task list, then ask your agent to implement the feature.
43
51
44
52
## Detailed Example: Building Taskify
45
53
46
54
Here's a complete example of building a team productivity platform:
47
55
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`
49
65
50
66
```text
51
67
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
66
82
delete any comments that you made, but you can't delete comments anybody else made.
67
83
```
68
84
69
-
### Step 2: Refine the Specification
85
+
### Step 3: Refine the Specification
70
86
71
87
After the initial specification is created, clarify any missing requirements:
72
88
@@ -82,7 +98,7 @@ Also validate the specification checklist:
82
98
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.
83
99
```
84
100
85
-
### Step 3: Generate Technical Plan with `/speckit.plan`
101
+
### Step 4: Generate Technical Plan with `/speckit.plan`
86
102
87
103
Be specific about your tech stack and technical requirements:
88
104
@@ -92,7 +108,7 @@ Blazor server with drag-and-drop task boards, real-time updates. There should be
0 commit comments