sedd 0.1.2 → 0.1.4

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.
Files changed (2) hide show
  1. package/README.md +113 -99
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -20,152 +20,172 @@
20
20
 
21
21
  ## Quick Start
22
22
 
23
- ### Instalação
24
-
25
23
  ```bash
24
+ # Instalar
26
25
  npm install -g sedd
27
- ```
28
-
29
- ### Uso
30
26
 
31
- ```bash
32
- # 1. Navegue para seu projeto
27
+ # Inicializar no projeto
33
28
  cd meu-projeto
34
-
35
- # 2. Inicialize SEDD
36
29
  sedd init
37
30
 
38
- # 3. Crie uma feature spec
31
+ # Criar feature spec
39
32
  sedd specify 001 user-auth
40
33
 
41
- # 4. Edite a spec
42
- # .sedd/001-user-auth/spec.md
43
-
44
- # 5. Use seu LLM favorito para implementar
34
+ # Usar AI assistant
45
35
  claude # ou cursor, copilot, etc.
46
36
 
47
- # 6. Documente decisões
48
- sedd clarify
37
+ # Comandos no AI
38
+ /sedd.clarify # Definir expectativa e gerar tasks
39
+ /sedd.implement # Executar tasks
49
40
  ```
50
41
 
51
- ### Comandos
52
-
53
- | Comando | Descrição |
54
- |---------|-----------|
55
- | `sedd init` | Inicializar SEDD no projeto |
56
- | `sedd specify <id> <name>` | Criar nova feature spec |
57
- | `sedd clarify` | Criar migration com decisões |
58
- | `sedd status` | Ver status atual |
59
- | `sedd --help` | Ver todos os comandos |
60
-
61
42
  ---
62
43
 
63
44
  ## O que é SEDD?
64
45
 
65
- SEDD é um toolkit que transforma a forma como você desenvolve software com AI assistants. Em vez de apenas especificar *o que* construir, você também captura *como espera que funcione* - suas expectativas como desenvolvedor.
46
+ SEDD captura sua **expectativa** antes de qualquer código. A AI sempre sabe o que você espera.
66
47
 
67
48
  ```
68
- SEDD = Spec Driven Development + Expectativas do Dev
69
- ```
49
+ 🎯 EXPECTATIVA: "User can toggle dark mode and persist across sessions"
70
50
 
71
- ### O Superpoder
51
+ 📊 Coverage: ~85% 🟢
72
52
 
73
- SEDD captura três dimensões:
74
-
75
- | Dimensão | Pergunta | Artefato |
76
- |----------|----------|----------|
77
- | **Spec** | O que o sistema faz? | `spec.md` |
78
- | **Expectation** | Como você espera que funcione? | `clarify.md` |
79
- | **Decision** | Por que foi decidido assim? | `decisions.md` |
53
+ Tasks:
54
+ - T001-001: Create ThemeContext
55
+ - T001-002: Add toggle component
56
+ - T001-003: Persist to localStorage
57
+ ```
80
58
 
81
59
  ---
82
60
 
83
- ## Por que SEDD?
61
+ ## Expectation-First Workflow
84
62
 
85
- Ao trabalhar com AI assistants em projetos de desenvolvimento:
63
+ ### 1. Captura Obrigatória
86
64
 
87
- | Problema | Sem SEDD | Com SEDD |
88
- |----------|----------|----------|
89
- | **Contexto perdido** | AI "esquece" decisões anteriores | Tudo documentado em migrations |
90
- | **Falta de rastreabilidade** | "Por que fizemos assim?" | `decisions.md` com timestamps |
91
- | **Specs vagas** | Retrabalho constante | Clarificação interativa |
92
- | **Tasks desorganizadas** | Espalhadas ou esquecidas | `tasks.md` com IDs únicos |
93
- | **Difícil retomar** | Onde parei? O que falta? | `progress.md` atualizado |
65
+ Ao usar `/sedd.specify` ou `/sedd.clarify`, a AI pergunta primeiro:
94
66
 
95
- ---
67
+ ```
68
+ 🎯 Qual é sua EXPECTATIVA para esta feature?
69
+
70
+ O que você espera ver funcionando quando estiver pronto?
71
+ ```
96
72
 
97
- ## Como Funciona
73
+ ### 2. Score de Alinhamento
98
74
 
99
- ### Fluxo em 4 Passos
75
+ Ao gerar tasks, SEDD calcula cobertura:
100
76
 
101
77
  ```
102
- ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
103
- │ 1. SPECIFY │ → │ 2. CLARIFY │ → │ 3. TASKS │ → │ 4. IMPLEMENT│
104
- │ │ │ │ │ │ │ │
105
- O que? │ │ Como? │ │ Quanto? │ │ Fazer! │
106
- spec.md │ │ clarify.md │ │ tasks.md │ │ código │
107
- └─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
78
+ 📊 Coverage: ~83% 🟢
79
+
80
+ Tokens encontrados:
81
+ toggle (T001-003)
82
+ dark mode (T001-003, T001-004)
83
+ ✅ persist (T001-003)
84
+ ❌ sessions - não encontrado
85
+
86
+ ⚠️ Deseja adicionar tasks para cobrir os gaps? [Y/n]
108
87
  ```
109
88
 
110
- ### Estrutura de Pastas
89
+ ### 3. Acceptance Criteria Automático
90
+
91
+ SEDD gera `acceptance.md` baseado na expectativa:
92
+
93
+ ```markdown
94
+ ## Checklist de Aceite
111
95
 
96
+ - [ ] AC-001: User can toggle dark mode
97
+ - [ ] AC-002: Toggle está em settings
98
+ - [ ] AC-003: Theme persists after refresh
99
+ - [ ] AC-004: Theme persists across sessions
112
100
  ```
113
- .sedd/001-user-auth/
114
- ├── spec.md # Especificação base
115
- ├── _meta.json # Metadados
116
-
117
- ├── M001/ # Migration 1
118
- │ ├── clarify.md # Discussão
119
- │ ├── decisions.md # Decisões
120
- │ └── tasks.md # Tasks T001-XXX
121
-
122
- ├── M002/ # Migration 2
123
- │ ├── clarify.md
124
- │ ├── decisions.md
125
- │ └── tasks.md # Tasks T002-XXX
126
-
127
- └── progress.md # Progresso geral
101
+
102
+ ### 4. Checkpoints Durante Implementação
103
+
104
+ A cada 3 tasks, SEDD verifica alinhamento:
105
+
128
106
  ```
107
+ ⏸️ Checkpoint - 3/10 tasks completas
129
108
 
130
- ---
109
+ Sua expectativa:
110
+ > User can toggle dark mode and persist
131
111
 
132
- ## Migrations: O Diferencial
112
+ Isso ainda está alinhado? [Y/n/ajustar]
113
+ ```
133
114
 
134
- O grande diferencial do SEDD é o sistema de **migrations incrementais**.
115
+ ### 5. Validação Final
135
116
 
136
- Você não precisa saber tudo no início. Pode clarificar aos poucos:
117
+ Ao completar migration, valida contra acceptance criteria:
137
118
 
138
- ```bash
139
- sedd clarify → Migration M001 (5 tasks)
140
- # implemente...
141
- sedd clarify → Migration M002 (3 tasks mais)
142
- # implemente...
143
- sedd clarify → Migration M003 (ajustes)
144
119
  ```
120
+ 🏁 Migration 001 Completa!
145
121
 
146
- ### Benefícios
122
+ Acceptance Criteria:
123
+ - [x] AC-001: User can toggle ✓
124
+ - [x] AC-002: Toggle in settings ✓
125
+ - [ ] AC-003: Persist after refresh ✗
147
126
 
148
- - **Histórico completo**: Cada decisão tem timestamp e contexto
149
- - **Rastreabilidade**: Task T002-003 → Migration M002 → Decisão
150
- - **Flexibilidade**: Implemente M001, depois clarifica mais
151
- - **Retomada fácil**: Volte semanas depois e saiba onde parou
127
+ Criar migration de follow-up? [Y/n]
128
+ ```
152
129
 
153
130
  ---
154
131
 
155
- ## Slash Commands (AI Assistants)
132
+ ## Comandos CLI
133
+
134
+ | Comando | Descrição |
135
+ |---------|-----------|
136
+ | `sedd init` | Inicializar SEDD no projeto |
137
+ | `sedd specify <id> <name>` | Criar nova feature spec |
138
+ | `sedd clarify` | Criar migration com decisões |
139
+ | `sedd status` | Ver status atual |
156
140
 
157
- Use estes comandos no Claude Code, Cursor, etc:
141
+ ## Slash Commands (AI)
158
142
 
159
143
  | Comando | Descrição |
160
144
  |---------|-----------|
161
- | `/sedd.specify` | Criar spec base |
162
- | `/sedd.clarify` | Clarificar e gerar tasks |
163
- | `/sedd.tasks` | Adicionar tasks à migration |
164
- | `/sedd.implement` | Executar tasks |
145
+ | `/sedd.specify` | Criar spec (pergunta expectativa primeiro) |
146
+ | `/sedd.clarify` | Clarificar e gerar tasks com score |
147
+ | `/sedd.implement` | Executar tasks com checkpoints |
165
148
  | `/sedd.implement --all` | Executar tudo sem parar |
166
149
 
167
150
  ---
168
151
 
152
+ ## Estrutura de Pastas
153
+
154
+ ```
155
+ .sedd/001-user-auth/
156
+ ├── spec.md # Especificação + Expectativa
157
+ ├── _meta.json # Metadados + expectation field
158
+
159
+ ├── 001_timestamp/ # Migration 1
160
+ │ ├── clarify.md # Discussão
161
+ │ ├── decisions.md # Decisões
162
+ │ ├── tasks.md # Tasks T001-XXX
163
+ │ └── acceptance.md # Critérios de aceite
164
+
165
+ └── progress.md # Progresso + checkpoints
166
+ ```
167
+
168
+ ---
169
+
170
+ ## Hooks Inteligentes
171
+
172
+ O hook `check-roadmap.js` sempre mostra:
173
+
174
+ ```xml
175
+ <sedd-context>
176
+ Branch: 024-feature | Migration: 001 | Progress: 3/10 🟢 ~85%
177
+
178
+ 🎯 FEATURE: User can customize theme
179
+ 📍 MIGRATION 001: Toggle dark mode with persistence
180
+
181
+ Pending tasks:
182
+ - T001-004: Add to settings page
183
+ - T001-005: API endpoint
184
+ </sedd-context>
185
+ ```
186
+
187
+ ---
188
+
169
189
  ## Configuração
170
190
 
171
191
  `sedd.config.json`:
@@ -178,12 +198,6 @@ Use estes comandos no Claude Code, Cursor, etc:
178
198
  }
179
199
  ```
180
200
 
181
- | Opção | Default | Descrição |
182
- |-------|---------|-----------|
183
- | `specsDir` | `.sedd` | Pasta das specs |
184
- | `branchPattern` | `{{id}}-{{name}}` | Formato do nome da branch |
185
- | `scriptRunner` | `auto` | `auto`, `powershell`, ou `bash` |
186
-
187
201
  ---
188
202
 
189
203
  ## Licença
@@ -195,5 +209,5 @@ MIT
195
209
  <p align="center">
196
210
  <b>Especificações dizem O QUE construir.<br>
197
211
  Expectativas dizem COMO você imagina que deve funcionar.<br>
198
- Juntas, são o superpoder que faltava.</b>
212
+ SEDD garante que as duas estejam sempre alinhadas.</b>
199
213
  </p>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sedd",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "SEDD - Spec & Expectation Driven Development. A phase-based specification workflow for AI-assisted development.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -14,7 +14,8 @@
14
14
  "templates",
15
15
  "commands",
16
16
  "scripts",
17
- "hooks"
17
+ "hooks",
18
+ "README.md"
18
19
  ],
19
20
  "scripts": {
20
21
  "build": "tsc",