specsmd 0.0.0-dev.26 → 0.0.0-dev.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/flows/simple/quick-start.md +219 -0
- package/lib/constants.js +4 -6
- package/package.json +1 -1
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
# specsmd Simple Flow Quick Start Guide
|
|
2
|
+
|
|
3
|
+
Get started with spec-driven development in minutes.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx specsmd@latest install
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Select **Simple** when prompted for the SDLC flow.
|
|
14
|
+
|
|
15
|
+
The installer will:
|
|
16
|
+
|
|
17
|
+
1. Detect available agentic coding tools (Claude Code, Cursor, etc.)
|
|
18
|
+
2. Install the spec agent and skills
|
|
19
|
+
3. Set up slash commands for your tools
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Three-Phase Workflow
|
|
24
|
+
|
|
25
|
+
Simple Flow has three sequential phases:
|
|
26
|
+
|
|
27
|
+
| Phase | Output | Purpose |
|
|
28
|
+
|-------|--------|---------|
|
|
29
|
+
| **Requirements** | `requirements.md` | Define what to build with user stories and EARS criteria |
|
|
30
|
+
| **Design** | `design.md` | Create technical design with architecture and data models |
|
|
31
|
+
| **Tasks** | `tasks.md` | Generate implementation checklist with coding tasks |
|
|
32
|
+
|
|
33
|
+
One agent (`/specsmd-agent`) guides you through all phases.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Quick Start Flow
|
|
38
|
+
|
|
39
|
+
### Step 1: Create a New Spec
|
|
40
|
+
|
|
41
|
+
Open your AI coding tool and invoke the agent with your feature idea:
|
|
42
|
+
|
|
43
|
+
```text
|
|
44
|
+
/specsmd-agent Create a user authentication system with email login
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The agent will:
|
|
48
|
+
1. Derive a feature name (`user-auth`)
|
|
49
|
+
2. Generate a requirements document
|
|
50
|
+
3. Ask for your approval
|
|
51
|
+
|
|
52
|
+
### Step 2: Review Requirements
|
|
53
|
+
|
|
54
|
+
The agent generates:
|
|
55
|
+
- **Introduction** - Feature summary
|
|
56
|
+
- **Glossary** - Domain terms
|
|
57
|
+
- **Requirements** - User stories with EARS acceptance criteria
|
|
58
|
+
|
|
59
|
+
**Approval phrases:** "yes", "approved", "looks good", "let's continue"
|
|
60
|
+
|
|
61
|
+
**Feedback:** Any other response triggers revision
|
|
62
|
+
|
|
63
|
+
### Step 3: Review Design
|
|
64
|
+
|
|
65
|
+
After requirements approval, the agent generates:
|
|
66
|
+
- **Architecture** - System overview with Mermaid diagrams
|
|
67
|
+
- **Components** - Interfaces and responsibilities
|
|
68
|
+
- **Data Models** - Types with validation rules
|
|
69
|
+
- **Error Handling** - Strategies for edge cases
|
|
70
|
+
- **Testing Strategy** - Test categories and coverage
|
|
71
|
+
|
|
72
|
+
### Step 4: Review Tasks
|
|
73
|
+
|
|
74
|
+
After design approval, the agent generates:
|
|
75
|
+
- **Numbered checkbox list** - Incremental coding steps
|
|
76
|
+
- **Requirement references** - Traceability to requirements
|
|
77
|
+
- **Checkpoint tasks** - Verification points
|
|
78
|
+
|
|
79
|
+
### Step 5: Execute Tasks
|
|
80
|
+
|
|
81
|
+
Once all three documents are approved:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
/specsmd-agent What's the next task?
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Or specify a task:
|
|
88
|
+
|
|
89
|
+
```text
|
|
90
|
+
/specsmd-agent Execute task 2.1 from user-auth
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The agent executes one task at a time, then waits for your review.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Commands Reference
|
|
98
|
+
|
|
99
|
+
### Single Agent: `/specsmd-agent`
|
|
100
|
+
|
|
101
|
+
| Action | Example |
|
|
102
|
+
|--------|---------|
|
|
103
|
+
| Create new spec | `/specsmd-agent Create a todo app with local storage` |
|
|
104
|
+
| Continue existing | `/specsmd-agent` (lists specs if multiple exist) |
|
|
105
|
+
| Resume specific spec | `/specsmd-agent --spec="todo-app"` |
|
|
106
|
+
| Execute tasks | `/specsmd-agent What's the next task?` |
|
|
107
|
+
| Execute specific task | `/specsmd-agent Execute task 3.2` |
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## File Structure
|
|
112
|
+
|
|
113
|
+
After creating specs, your project will have:
|
|
114
|
+
|
|
115
|
+
```text
|
|
116
|
+
.specsmd/
|
|
117
|
+
├── manifest.yaml # Installation manifest
|
|
118
|
+
└── simple/ # Simple flow resources
|
|
119
|
+
├── agents/agent.md # Agent definition
|
|
120
|
+
├── skills/ # Agent skills
|
|
121
|
+
│ ├── requirements.md # Phase 1
|
|
122
|
+
│ ├── design.md # Phase 2
|
|
123
|
+
│ ├── tasks.md # Phase 3
|
|
124
|
+
│ └── execute.md # Task execution
|
|
125
|
+
├── templates/ # Document templates
|
|
126
|
+
├── memory-bank.yaml # Storage schema
|
|
127
|
+
└── quick-start.md # This file
|
|
128
|
+
|
|
129
|
+
memory-bank/
|
|
130
|
+
└── specs/ # Your feature specs
|
|
131
|
+
└── {feature-name}/
|
|
132
|
+
├── requirements.md # What to build
|
|
133
|
+
├── design.md # How to build it
|
|
134
|
+
└── tasks.md # Step-by-step plan
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## EARS Format
|
|
140
|
+
|
|
141
|
+
Requirements use EARS (Easy Approach to Requirements Syntax):
|
|
142
|
+
|
|
143
|
+
| Pattern | Format |
|
|
144
|
+
|---------|--------|
|
|
145
|
+
| **Event-driven** | WHEN [trigger], THE [system] SHALL [response] |
|
|
146
|
+
| **State-driven** | WHILE [condition], THE [system] SHALL [response] |
|
|
147
|
+
| **Unwanted** | IF [condition], THEN THE [system] SHALL [response] |
|
|
148
|
+
| **Optional** | WHERE [option], THE [system] SHALL [response] |
|
|
149
|
+
|
|
150
|
+
Example:
|
|
151
|
+
```
|
|
152
|
+
WHEN user submits login form, THE Auth_System SHALL validate credentials
|
|
153
|
+
IF password is invalid, THEN THE Auth_System SHALL display error message
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## Key Principles
|
|
159
|
+
|
|
160
|
+
### Generate First, Ask Later
|
|
161
|
+
The agent generates a draft immediately. Your feedback refines it.
|
|
162
|
+
|
|
163
|
+
### Explicit Approval Required
|
|
164
|
+
You must explicitly approve each phase before proceeding.
|
|
165
|
+
|
|
166
|
+
### One Phase at a Time
|
|
167
|
+
Complete each phase before moving to the next.
|
|
168
|
+
|
|
169
|
+
### One Task at a Time
|
|
170
|
+
During execution, only one task per interaction. Review before continuing.
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Tips for Success
|
|
175
|
+
|
|
176
|
+
1. **Be specific** - "User auth with email/password and session management" beats "Login feature"
|
|
177
|
+
2. **Use the glossary** - Define domain terms for consistent language
|
|
178
|
+
3. **Check INCOSE rules** - Singular, Complete, Verifiable, Unambiguous, Consistent
|
|
179
|
+
4. **Include edge cases** - Error scenarios in acceptance criteria
|
|
180
|
+
5. **Review checkpoints** - Verify tests pass during execution
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Troubleshooting
|
|
185
|
+
|
|
186
|
+
### Agent doesn't remember context
|
|
187
|
+
The agent is stateless. It reads spec files at startup. Ensure documents are saved.
|
|
188
|
+
|
|
189
|
+
### Multiple specs exist
|
|
190
|
+
When you run `/specsmd-agent` without arguments, it lists existing specs and asks which to work on.
|
|
191
|
+
|
|
192
|
+
### Want to start over
|
|
193
|
+
Delete the spec folder: `rm -rf memory-bank/specs/{feature-name}`
|
|
194
|
+
|
|
195
|
+
### Get help
|
|
196
|
+
Ask the agent: `/specsmd-agent How do I add a new requirement?`
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## When to Use Simple Flow vs AI-DLC
|
|
201
|
+
|
|
202
|
+
| Simple Flow | AI-DLC Flow |
|
|
203
|
+
|-------------|-------------|
|
|
204
|
+
| Quick feature specs | Full development lifecycle |
|
|
205
|
+
| Solo or small team | Multi-team coordination |
|
|
206
|
+
| Prototypes & MVPs | Production systems |
|
|
207
|
+
| Minimal overhead | Full traceability |
|
|
208
|
+
| 1 agent, 3 phases | 4 agents, full methodology |
|
|
209
|
+
|
|
210
|
+
---
|
|
211
|
+
|
|
212
|
+
## What's Next?
|
|
213
|
+
|
|
214
|
+
1. Run `/specsmd-agent` with your feature idea
|
|
215
|
+
2. Review and approve requirements → design → tasks
|
|
216
|
+
3. Execute tasks one at a time
|
|
217
|
+
4. Ship your feature!
|
|
218
|
+
|
|
219
|
+
Happy spec-driven development!
|
package/lib/constants.js
CHANGED
|
@@ -17,12 +17,10 @@ const FLOWS = {
|
|
|
17
17
|
description: 'AI-Driven Development Life Cycle - Best for greenfield projects with AI-native development',
|
|
18
18
|
path: 'aidlc'
|
|
19
19
|
},
|
|
20
|
-
|
|
21
|
-
name: '
|
|
22
|
-
description: '
|
|
23
|
-
path: '
|
|
24
|
-
disabled: true, // Not implemented yet
|
|
25
|
-
message: '(Coming soon)'
|
|
20
|
+
simple: {
|
|
21
|
+
name: 'Simple',
|
|
22
|
+
description: 'Spec-driven development - Best for quick feature specs without full methodology overhead',
|
|
23
|
+
path: 'simple'
|
|
26
24
|
}
|
|
27
25
|
};
|
|
28
26
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "specsmd",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.27",
|
|
4
4
|
"description": "Multi-agent orchestration system for AI-native software development. Delivers AI-DLC, Agile, and custom SDLC flows as markdown-based agent systems.",
|
|
5
5
|
"main": "lib/installer.js",
|
|
6
6
|
"bin": {
|