ros/spec-kit
1
0
Fork 0
mirror of https://github.com/github/spec-kit.git synced 2026-02-01 05:23:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update command reference

Browse Source
This commit is contained in:
den (work)
2025-10-06 22:16:48 -07:00
parent cde400f466
commit 15e5572a1d
14 changed files with 83 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
spec-driven.md
View File

@@ -74,7 +74,7 @@ The key is treating specifications as the source of truth, with code as the gene
The SDD methodology is significantly enhanced through three powerful commands that automate the specification → planning → tasking workflow:
### The `/specify` Command
### The `/speckit.specify` Command
This command transforms a simple feature description (the user-prompt) into a complete, structured specification with automatic repository management:
@@ -83,7 +83,7 @@ This command transforms a simple feature description (the user-prompt) into a co
3. **Template-Based Generation**: Copies and customizes the feature specification template with your requirements
4. **Directory Structure**: Creates the proper `specs/[branch-name]/` structure for all related documents
### The `/plan` Command
### The `/speckit.plan` Command
Once a feature specification exists, this command creates a comprehensive implementation plan:
@@ -93,7 +93,7 @@ Once a feature specification exists, this command creates a comprehensive implem
4. **Detailed Documentation**: Generates supporting documents for data models, API contracts, and test scenarios
5. **Quickstart Validation**: Produces a quickstart guide capturing key validation scenarios
### The `/tasks` Command
### The `/speckit.tasks` Command
After a plan is created, this command analyzes the plan and related design documents to generate an executable task list:
@@ -121,7 +121,7 @@ Total: ~12 hours of documentation work
```bash
# Step 1: Create the feature specification (5 minutes)
/specify Real-time chat system with message history and user presence
/speckit.specify Real-time chat system with message history and user presence
# This automatically:
# - Creates branch "003-chat-system"
@@ -129,10 +129,10 @@ Total: ~12 hours of documentation work
# - Populates it with structured requirements
# Step 2: Generate implementation plan (5 minutes)
/plan WebSocket for real-time messaging, PostgreSQL for history, Redis for presence
/speckit.plan WebSocket for real-time messaging, PostgreSQL for history, Redis for presence
# Step 3: Generate executable tasks (5 minutes)
/tasks
/speckit.tasks
# This automatically creates:
# - specs/003-chat-system/plan.md