sdd-toolkit 1.5.0 β 1.6.0
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/README.md +139 -155
- package/README.pt.md +135 -0
- package/definitions/{dev.coder.yaml β coder.yaml} +15 -22
- package/definitions/feature.yaml +74 -0
- package/definitions/log.yaml +61 -0
- package/definitions/project.yaml +108 -0
- package/definitions/requirements.yaml +71 -0
- package/definitions/review.yaml +88 -0
- package/definitions/sdd.yaml +30 -0
- package/package.json +1 -1
- package/src/commands/view.js +18 -0
- package/src/index.js +335 -284
- package/src/lib/agents.js +1 -1
- package/src/lib/dashboard.js +188 -0
- package/src/lib/docs.js +2 -1
- package/src/lib/messages.js +57 -9
- package/src/lib/transformers.js +332 -246
- package/src/scripts/archive.js +5 -5
- package/src/scripts/reset.js +4 -4
- package/src/scripts/status.js +7 -7
- package/templates/milestones.md +1 -1
- package/definitions/dev.auditor.yaml +0 -66
- package/definitions/dev.feature.yaml +0 -105
- package/definitions/dev.log.yaml +0 -90
- package/definitions/dev.milestone.yaml +0 -75
- package/definitions/dev.ops.yaml +0 -51
- package/definitions/dev.project.yaml +0 -106
- package/definitions/dev.requirements.yaml +0 -91
- package/definitions/dev.review.yaml +0 -61
- package/definitions/dev.tasks.yaml +0 -84
package/README.md
CHANGED
|
@@ -1,155 +1,139 @@
|
|
|
1
|
-
# sdd-toolkit (Universal Spec CLI)
|
|
2
|
-
|
|
3
|
-
CLI tool to automatically set up the development environment and install AI agents (Auditor, Coder, etc.) for various modern AI tools.
|
|
4
|
-
|
|
5
|
-
## Overview
|
|
6
|
-
|
|
7
|
-
**sdd-toolkit** is an "AI Agent Package Manager". It defines a standard squad of AI Developers and installs them directly into the context of your favorite AI Coding Assistant (such as Gemini, Roo Code, Kilo Code, OpenCode).
|
|
8
|
-
|
|
9
|
-
The main idea is to stop creating prompts from scratch and install a proven, structured workflow.
|
|
10
|
-
|
|
11
|
-
## Key Features
|
|
12
|
-
|
|
13
|
-
### 1.
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
**
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
|
|
53
|
-
###
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
The
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
|
|
91
|
-
###
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
-
|
|
114
|
-
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
- **Roo Code / Cline:** Generates custom modes (`_custom_modes.json`) and rules in `.roo/` or `.cline/`.
|
|
141
|
-
- **GitHub Copilot:** Generates instructions in `.github/copilot-instructions.md` and agents in `.github/agents/`.
|
|
142
|
-
- **Kilo Code:** Generates workflows in `.kilocode/workflows/`.
|
|
143
|
-
- **OpenCode:** Generates files in `.opencode/command/`.
|
|
144
|
-
- **Others:** Support for Cursor, Windsurf, Trae, OpenAI/Claude Web.
|
|
145
|
-
|
|
146
|
-
This way, **sdd-toolkit** acts as a bridge between agent behavior definitions and the tool you use for coding, ensuring your AI "team" is always configured and ready to work.
|
|
147
|
-
|
|
148
|
-
## Project Structure
|
|
149
|
-
|
|
150
|
-
- `src/`: CLI source code.
|
|
151
|
-
- `definitions/`: YAML agent definitions (agnostic).
|
|
152
|
-
|
|
153
|
-
## License
|
|
154
|
-
|
|
155
|
-
MIT
|
|
1
|
+
# sdd-toolkit (Universal Spec CLI)
|
|
2
|
+
|
|
3
|
+
CLI tool to automatically set up the development environment and install AI agents (Auditor, Coder, etc.) for various modern AI tools.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
**sdd-toolkit** is an "AI Agent Package Manager". It defines a standard squad of AI Developers and installs them directly into the context of your favorite AI Coding Assistant (such as Gemini, Roo Code, Kilo Code, OpenCode).
|
|
8
|
+
|
|
9
|
+
The main idea is to stop creating prompts from scratch and install a proven, structured workflow.
|
|
10
|
+
|
|
11
|
+
## π Key Features
|
|
12
|
+
|
|
13
|
+
### 1. Smart & Agile Workflow
|
|
14
|
+
- **Hybrid Flow:** Supports both "Waterfall" planning (for new projects) and "Agile" execution (for hotfixes/features).
|
|
15
|
+
- **Smart Context:** Agents automatically scan your `package.json`, `go.mod`, or `requirements.txt` to understand your stack. No more explaining "I use React" every time.
|
|
16
|
+
- **Unified Memory:** All context is stored in a hidden `.sdd-toolkit/` folder, keeping your root directory clean.
|
|
17
|
+
|
|
18
|
+
### 2. "Power Commands"
|
|
19
|
+
Agents come equipped with special execution modes triggered by commands:
|
|
20
|
+
- **`/sdd`**: Access help and list all available agents.
|
|
21
|
+
- **`/flow:debug`**: Paste an error log, and the Coder enters "Surgical Mode" to fix it immediately.
|
|
22
|
+
- **`/flow:tdd`**: Forces the Red-Green-Refactor cycle for high-quality code.
|
|
23
|
+
- **`/flow:refactor`**: Applies Clean Code principles to an existing file.
|
|
24
|
+
- **`/flow:gen-tests`**: Automatically generates unit tests for your code.
|
|
25
|
+
- **`/flow:security`**: Scans your code/plan for vulnerabilities (OWASP).
|
|
26
|
+
- **`/flow:sync`**: Updates the documentation (`project.md`) to match the actual code (Reverse Engineering).
|
|
27
|
+
|
|
28
|
+
### 3. AI Agent Installation
|
|
29
|
+
Reads agnostic definitions (YAML) and converts them to specific formats:
|
|
30
|
+
- **Gemini CLI:** Generates `.toml` configuration files.
|
|
31
|
+
- **Roo Code / Cline:** Generates custom modes (`_custom_modes.json`) and context rules in `.roo/` or `.cline/`.
|
|
32
|
+
- **GitHub Copilot:** Generates instructions in `.github/copilot-instructions.md` and agents in `.github/agents/`.
|
|
33
|
+
- **Cursor:** Generates rules in `.cursor/rules/*.mdc`.
|
|
34
|
+
- **Windsurf:** Generates rules in `.windsurfrules`.
|
|
35
|
+
- **Trae:** Generates instructions in `.trae/instructions.md`.
|
|
36
|
+
- **OpenCode:** Generates agents in `.opencode/`.
|
|
37
|
+
- **Kilo Code:** Generates Markdown prompts (`.kilo/prompts/*.md`).
|
|
38
|
+
|
|
39
|
+
## π₯ The Squad (Agent Roles)
|
|
40
|
+
|
|
41
|
+
The system installs a team of specialized agents:
|
|
42
|
+
|
|
43
|
+
### ποΈ Strategic Agents
|
|
44
|
+
- **@Project Architect:** Defines the scope and principles.
|
|
45
|
+
- **@Requirements Engineer:** Defines the tech stack (Auto-detected).
|
|
46
|
+
- **@Milestone Manager:** Creates the roadmap.
|
|
47
|
+
|
|
48
|
+
### β‘ Execution Agents
|
|
49
|
+
- **@Task Planner:** Breaks down milestones into atomic tasks.
|
|
50
|
+
- **@Feature Manager:** The agile entry point. Handles requests like "Add Google Login" and decides the best path (Hotfix vs Milestone).
|
|
51
|
+
- **@Coder:** The senior developer. Supports TDD, Debug, Refactor, and Test Generation modes.
|
|
52
|
+
|
|
53
|
+
### π‘οΈ Quality Agents
|
|
54
|
+
- **@QA Engineer:** Reviews code against the spec (Auditor role).
|
|
55
|
+
- **@DevOps Engineer:** Handles Docker, CI/CD, and Configs.
|
|
56
|
+
- **@Release Manager:** Consolidates logs and manages the changelog.
|
|
57
|
+
- **@SDD Helper:** Provides access to all agents and help.
|
|
58
|
+
|
|
59
|
+
## Installation and Usage
|
|
60
|
+
|
|
61
|
+
You can run the tool directly via `npx` without prior installation:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx sdd-toolkit
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Or install globally:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npm install -g sdd-toolkit
|
|
71
|
+
sdd-toolkit
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## How it Works
|
|
75
|
+
|
|
76
|
+
1. **Initialization:** The wizard detects your tools and sets up the hidden `.sdd-toolkit/` context folder.
|
|
77
|
+
2. **Agent Building:** It reads the "Thinking Protocols" (YAML) and compiles them into your AI tool's native format.
|
|
78
|
+
3. **Execution:** You interact with the agents using simplified commands (e.g., `/project`, `/coder`) or the new `/flow:*` triggers.
|
|
79
|
+
|
|
80
|
+
## Complete Development Flow
|
|
81
|
+
|
|
82
|
+
The sdd-toolkit implements a **unified hybrid workflow** that adapts to your needs, combining structured planning for new projects with agile execution for quick fixes. It ensures traceability, justification, and quality through AI-human collaboration.
|
|
83
|
+
|
|
84
|
+
### Unified Hybrid Workflow Overview
|
|
85
|
+
|
|
86
|
+
- **Adaptive Initiation:** Start with `/start "DescriΓ§Γ£o"` for intelligent routing. The system checks existing docs and decides between quick or structured paths.
|
|
87
|
+
- **Conditional Planning:** If needed, escalates to full planning (Project Architect β Requirements Engineer β Milestone Manager β Task Planner).
|
|
88
|
+
- **Standardized Execution:** Coders implement tasks with logs, followed by unified validation (QA and Auditor).
|
|
89
|
+
- **Finalization:** Release Manager consolidates into changelog with human confirmation.
|
|
90
|
+
|
|
91
|
+
### Detailed Flow Steps
|
|
92
|
+
|
|
93
|
+
#### 1. Initiation (Inteligente)
|
|
94
|
+
- Command: `/start "Build a login system"`
|
|
95
|
+
- Action: Project Architect checks for existing `.sdd-toolkit/project.md`.
|
|
96
|
+
- If none: Enters interview mode for basics.
|
|
97
|
+
- If exists: Confirms proceed or restart.
|
|
98
|
+
- Output: Updates `project.md` with hybrid notes (e.g., approval points).
|
|
99
|
+
|
|
100
|
+
#### 2. Planning (Condicional)
|
|
101
|
+
- If hotfix: Feature Manager routes directly to task creation.
|
|
102
|
+
- If project: Milestone Manager generates roadmap with human approval.
|
|
103
|
+
- Commands: `/requirements`, `/milestone`, `/tasks`.
|
|
104
|
+
- Output: `requirements.md`, `milestones.md`, `task.md`.
|
|
105
|
+
|
|
106
|
+
#### 3. Execution (Padronizada)
|
|
107
|
+
- Command: `/coder`
|
|
108
|
+
- Action: Coder reads context, implements, logs in `executions/`, marks tasks as done.
|
|
109
|
+
- Modes: `/flow:debug`, `/flow:refactor`, `/flow:tdd`, etc.
|
|
110
|
+
- Output: Code changes + execution logs.
|
|
111
|
+
|
|
112
|
+
#### 4. Validation (Unificada)
|
|
113
|
+
- Commands: `/review`
|
|
114
|
+
- Action: QA Engineer reviews code against the spec. Pauses for human input on ambiguities.
|
|
115
|
+
- Output: Review reports in `logs/reviews/`.
|
|
116
|
+
|
|
117
|
+
#### 5. Finalization (Com ConfirmaΓ§Γ£o)
|
|
118
|
+
- Command: `/release` or implicit after approval.
|
|
119
|
+
- Action: Release Manager updates `changelog.md` and archives logs after human confirmation.
|
|
120
|
+
- Output: Clean changelog and archived logs.
|
|
121
|
+
|
|
122
|
+
### Agent Interactions
|
|
123
|
+
Agents share context via `.sdd-toolkit/` files, ensuring no hallucinations. Power commands enable specialized modes. The flow promotes justification (e.g., "Why this decision?") and human-AI handoffs for reliability.
|
|
124
|
+
|
|
125
|
+
For examples, see the workflow guides generated in `.sdd-toolkit/`.
|
|
126
|
+
|
|
127
|
+
## Project Structure
|
|
128
|
+
|
|
129
|
+
- `src/`: CLI source code.
|
|
130
|
+
- `definitions/`: YAML agent definitions (agnostic).
|
|
131
|
+
- `templates/`: Documentation templates.
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
MIT
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
**Nota:** Uma versΓ£o em portuguΓͺs deste README estΓ‘ disponΓvel em [README.pt.md](README.pt.md).
|
package/README.pt.md
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# sdd-toolkit (CLI de EspecificaΓ§Γ£o Universal)
|
|
2
|
+
|
|
3
|
+
CLI tool para configurar automaticamente o ambiente de desenvolvimento e instalar agentes de IA (Auditor, Coder, etc.) para vΓ‘rias ferramentas modernas de IA.
|
|
4
|
+
|
|
5
|
+
## VisΓ£o Geral
|
|
6
|
+
|
|
7
|
+
**sdd-toolkit** Γ© um "Gerenciador de Pacotes de Agentes de IA". Ele define uma equipe padrΓ£o de Desenvolvedores de IA e os instala diretamente no contexto de sua assistente de codificaΓ§Γ£o de IA favorita (como Gemini, Roo Code, Kilo Code, OpenCode).
|
|
8
|
+
|
|
9
|
+
A ideia principal Γ© parar de criar prompts do zero e instalar um workflow comprovado e estruturado.
|
|
10
|
+
|
|
11
|
+
## π Recursos Principais
|
|
12
|
+
|
|
13
|
+
### 1. Workflow Inteligente e Γgil
|
|
14
|
+
- **Fluxo HΓbrido:** Suporta planejamento "Waterfall" (para novos projetos) e execuΓ§Γ£o "Agile" (para hotfixes).
|
|
15
|
+
- **Contexto Inteligente:** Os agentes escaneiam automaticamente seu `package.json`, `go.mod`, ou `requirements.txt` para entender sua stack. NΓ£o mais explicar "Eu uso React" toda vez.
|
|
16
|
+
- **MemΓ³ria Unificada:** Todo contexto Γ© armazenado em uma pasta oculta `.sdd-toolkit/`, mantendo sua raiz limpa.
|
|
17
|
+
|
|
18
|
+
### 2. "Comandos de PotΓͺncia"
|
|
19
|
+
Os agentes vΓͺm equipados com modos de execuΓ§Γ£o especiais acionados por comandos:
|
|
20
|
+
- **`/sdd`**: Acesso a ajuda e lista de todos os agentes disponΓveis.
|
|
21
|
+
- **`/flow:debug`**: Cole um log de erro e o Coder entra no "Modo CirΓΊrgico" para corrigir imediatamente.
|
|
22
|
+
- **`/flow:tdd`**: ForΓ§a o ciclo Red-Green-Refactor para cΓ³digo de alta qualidade.
|
|
23
|
+
- **`/flow:refactor`**: Aplica princΓpios de Clean Code a um arquivo existente.
|
|
24
|
+
- **`/flow:gen-tests`**: Gera automaticamente testes unitΓ‘rios para seu cΓ³digo.
|
|
25
|
+
- **`/flow:security`**: Escaneia seu cΓ³digo/plano em busca de vulnerabilidades (OWASP).
|
|
26
|
+
- **`/flow:sync`**: Atualiza a documentaΓ§Γ£o (`project.md`) para corresponder ao cΓ³digo real (Engenharia Reversa).
|
|
27
|
+
|
|
28
|
+
### 3. InstalaΓ§Γ£o de Agentes de IA
|
|
29
|
+
LΓͺ definiΓ§Γ΅es agnΓ³sticas (YAML) e as converte para formatos especΓficos:
|
|
30
|
+
- **Gemini CLI:** Gera arquivos de configuraΓ§Γ£o `.toml`.
|
|
31
|
+
- **Roo Code / Cline:** Gera modos customizados (`_custom_modes.json`) e regras de contexto em `.roo/` ou `.cline/`.
|
|
32
|
+
- **GitHub Copilot:** Gera instruΓ§Γ΅es em `.github/copilot-instructions.md` e agentes em `.github/agents/`.
|
|
33
|
+
- **Cursor:** Gera regras em `.cursor/rules/*.mdc`.
|
|
34
|
+
- **Windsurf:** Gera regras em `.windsurfrules`.
|
|
35
|
+
- **Trae:** Gera instruΓ§Γ΅es em `.trae/instructions.md`.
|
|
36
|
+
- **OpenCode:** Gera agentes em `.opencode/`.
|
|
37
|
+
- **Kilo Code:** Gera prompts Markdown (`.kilo/prompts/*.md`).
|
|
38
|
+
|
|
39
|
+
## π₯ A Equipe (FunΓ§Γ΅es dos Agentes)
|
|
40
|
+
|
|
41
|
+
O sistema instala uma equipe de agentes especializados:
|
|
42
|
+
|
|
43
|
+
### ποΈ Agentes EstratΓ©gicos
|
|
44
|
+
- **@Arquitetos de Projeto:** Define o escopo e princΓpios.
|
|
45
|
+
- **@Engenheiros de Requisitos:** Define a stack tΓ©cnica (Auto-detectada).
|
|
46
|
+
- **@Gerenciadores de Marcos:** Cria o roadmap.
|
|
47
|
+
|
|
48
|
+
### β‘ Agentes de ExecuΓ§Γ£o
|
|
49
|
+
- **@Planejadores de Tarefas:** Quebra marcos em tarefas atΓ΄micas.
|
|
50
|
+
- **@Gerenciadores de Recursos:** O ponto de entrada Γ‘gil. Trata solicitaΓ§Γ΅es como "Adicionar Login Google" e decide o melhor caminho (Hotfix vs Milestone).
|
|
51
|
+
- **@Codificadores:** O desenvolvedor sΓͺnior. Suporta modos TDD, Debug, Refactor e GeraΓ§Γ£o de Testes.
|
|
52
|
+
|
|
53
|
+
### π‘οΈ Agentes de Qualidade
|
|
54
|
+
- **@Auditores:** Verifica consistΓͺncia entre requisitos e tarefas.
|
|
55
|
+
- **@QA Engineers:** Revisa cΓ³digo contra a especificaΓ§Γ£o.
|
|
56
|
+
- **@DevOps Engineers:** Trata Docker, CI/CD e Configs.
|
|
57
|
+
- **@Gerenciadores de Releases:** Consolida logs e gerencia o changelog.
|
|
58
|
+
|
|
59
|
+
## InstalaΓ§Γ£o e Uso
|
|
60
|
+
|
|
61
|
+
VocΓͺ pode executar a ferramenta diretamente via `npx` sem instalaΓ§Γ£o prΓ©via:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx sdd-toolkit
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Ou instalar globalmente:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npm install -g sdd-toolkit
|
|
71
|
+
sdd-toolkit
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Como Funciona
|
|
75
|
+
|
|
76
|
+
1. **InicializaΓ§Γ£o:** O assistente detecta suas ferramentas e configura a pasta de contexto oculta `.sdd-toolkit/`.
|
|
77
|
+
2. **ConstruΓ§Γ£o de Agentes:** LΓͺ os "Protocolos de Pensamento" (YAML) e os compila no formato nativo da sua ferramenta de IA.
|
|
78
|
+
3. **ExecuΓ§Γ£o:** VocΓͺ interage com os agentes usando comandos simplificados (ex.: `/project`, `/coder`) ou os novos gatilhos `/flow:*`.
|
|
79
|
+
|
|
80
|
+
## Fluxo Completo de Desenvolvimento
|
|
81
|
+
|
|
82
|
+
O sdd-toolkit implementa um **fluxo de trabalho hΓbrido unificado** que se adapta Γ s suas necessidades, combinando planejamento estruturado para novos projetos com execuΓ§Γ£o Γ‘gil para correΓ§Γ΅es rΓ‘pidas. Ele garante rastreabilidade, justificativa e qualidade atravΓ©s de colaboraΓ§Γ£o IA-humana.
|
|
83
|
+
|
|
84
|
+
### VisΓ£o Geral do Fluxo HΓbrido Unificado
|
|
85
|
+
|
|
86
|
+
- **IniciaΓ§Γ£o Inteligente:** Comece com `/dev:start "DescriΓ§Γ£o"` para roteamento inteligente. O sistema verifica docs existentes e decide entre caminhos quick ou estruturados.
|
|
87
|
+
- **Planejamento Condicional:** Se necessΓ‘rio, escala para planejamento completo (Arquitetos de Projeto β Engenheiros de Requisitos β Gerenciadores de Marcos β Planejadores de Tarefas).
|
|
88
|
+
- **ExecuΓ§Γ£o Padronizada:** Codificadores implementam tarefas com logs, seguidos de validaΓ§Γ£o unificada (QA e Auditores).
|
|
89
|
+
- **FinalizaΓ§Γ£o:** Gerenciadores de Releases consolidam em changelog com confirmaΓ§Γ£o humana.
|
|
90
|
+
|
|
91
|
+
### Passos Detalhados do Fluxo
|
|
92
|
+
|
|
93
|
+
#### 1. IniciaΓ§Γ£o (Inteligente)
|
|
94
|
+
- Comando: `/start "Construir um sistema de login"`
|
|
95
|
+
- AΓ§Γ£o: Arquitetos de Projeto verificam `.sdd-toolkit/project.md` existente.
|
|
96
|
+
- Se nenhum: Entra no modo de entrevista para o bΓ‘sico.
|
|
97
|
+
- Se existe: Confirma prosseguir ou reiniciar.
|
|
98
|
+
- SaΓda: Atualiza `project.md` com notas hΓbridas (ex.: pontos de aprovaΓ§Γ£o).
|
|
99
|
+
|
|
100
|
+
#### 2. Planejamento (Condicional)
|
|
101
|
+
- Se hotfix: Gerenciadores de Recursos roteia diretamente para criaΓ§Γ£o de tarefas.
|
|
102
|
+
- Se projeto: Gerenciadores de Marcos gera roadmap com aprovaΓ§Γ£o humana.
|
|
103
|
+
- Comandos: `/requirements`, `/milestone`, `/tasks`.
|
|
104
|
+
- SaΓda: `requirements.md`, `milestones.md`, `task.md`.
|
|
105
|
+
|
|
106
|
+
#### 3. ExecuΓ§Γ£o (Padronizada)
|
|
107
|
+
- Comando: `/coder`
|
|
108
|
+
- AΓ§Γ£o: Codificador lΓͺ contexto, implementa, registra logs em `executions/`, marca tarefas como concluΓdas.
|
|
109
|
+
- Modos: `/flow:debug`, `/flow:refactor`, `/flow:tdd`, etc.
|
|
110
|
+
- SaΓda: MudanΓ§as no cΓ³digo + logs de execuΓ§Γ£o.
|
|
111
|
+
|
|
112
|
+
#### 4. ValidaΓ§Γ£o (Unificada)
|
|
113
|
+
- Comando: `/review`
|
|
114
|
+
- AΓ§Γ£o: QA revisa cΓ³digo, Auditores verificam consistΓͺncia. Pausa para entrada humana em ambiguidades.
|
|
115
|
+
- SaΓda: RelatΓ³rios de revisΓ£o em `logs/reviews/`.
|
|
116
|
+
|
|
117
|
+
#### 5. FinalizaΓ§Γ£o (Com ConfirmaΓ§Γ£o)
|
|
118
|
+
- Comando: `/release` ou implΓcito apΓ³s aprovaΓ§Γ£o.
|
|
119
|
+
- AΓ§Γ£o: Gerenciadores de Releases atualiza `changelog.md` e arquiva logs apΓ³s confirmaΓ§Γ£o humana.
|
|
120
|
+
- SaΓda: Changelog limpo e logs arquivados.
|
|
121
|
+
|
|
122
|
+
### InteraΓ§Γ΅es dos Agentes
|
|
123
|
+
Agentes compartilham contexto via arquivos `.sdd-toolkit/`, garantindo sem alucinaΓ§Γ΅es. Comandos de potΓͺncia habilitam modos especializados. O fluxo promove justificativa (ex.: "Por que essa decisΓ£o?") e handoffs IA-humana para confiabilidade.
|
|
124
|
+
|
|
125
|
+
Para exemplos, veja os guias de workflow gerados em `.sdd-toolkit/`.
|
|
126
|
+
|
|
127
|
+
## Estrutura do Projeto
|
|
128
|
+
|
|
129
|
+
- `src/`: CΓ³digo fonte da CLI.
|
|
130
|
+
- `definitions/`: DefiniΓ§Γ΅es YAML de agentes (agnΓ³sticas).
|
|
131
|
+
- `templates/`: Modelos de documentaΓ§Γ£o.
|
|
132
|
+
|
|
133
|
+
## LicenΓ§a
|
|
134
|
+
|
|
135
|
+
MIT
|
|
@@ -11,12 +11,12 @@ systemPrompt: |
|
|
|
11
11
|
You are the **Senior Software Engineer**.
|
|
12
12
|
You do not just "write code". You **architect solutions** at the file level.
|
|
13
13
|
You follow **SOLID** principles and **Clean Code** standards.
|
|
14
|
-
Your goal is to implement the task from
|
|
14
|
+
Your goal is to implement the task from `.sdd-toolkit/features/[feature-slug].md` with **Zero Regression**.
|
|
15
15
|
|
|
16
16
|
# INPUT CONTEXT
|
|
17
|
-
1. **Mandatory:** Read
|
|
18
|
-
2. **Mandatory:** Read
|
|
19
|
-
3. **Mandatory:** Read
|
|
17
|
+
1. **Mandatory:** Read `.sdd-toolkit/features/[feature-slug].md` (The Task context).
|
|
18
|
+
2. **Mandatory:** Read `.sdd-toolkit/requirements.md` (The Stack & Rules).
|
|
19
|
+
3. **Mandatory:** Read `.sdd-toolkit/project.md` (The Principles).
|
|
20
20
|
|
|
21
21
|
# EXECUTION WORKFLOW
|
|
22
22
|
|
|
@@ -40,39 +40,32 @@ systemPrompt: |
|
|
|
40
40
|
- *If Fail:* Fix the code.
|
|
41
41
|
|
|
42
42
|
## PHASE 4: REPORTING
|
|
43
|
-
1. **Update
|
|
44
|
-
2. **Log Work:**
|
|
43
|
+
1. **Update Feature File:** Mark the task as `[x]` in `.sdd-toolkit/features/[feature-slug].md`.
|
|
44
|
+
2. **Log Work:** Create a log file in `.sdd-toolkit/logs/executions/[Task_ID].md`.
|
|
45
45
|
|
|
46
|
-
# OUTPUT STRUCTURE (
|
|
46
|
+
# OUTPUT STRUCTURE (.sdd-toolkit/logs/executions/[Task_ID].md)
|
|
47
47
|
---
|
|
48
48
|
**Task:** [Task_ID]
|
|
49
49
|
**Status:** [Completed]
|
|
50
|
-
**
|
|
51
|
-
|
|
50
|
+
**Feature:** [feature-slug]
|
|
51
|
+
|
|
52
52
|
**Changes:**
|
|
53
53
|
- Created `src/components/Button.tsx`
|
|
54
54
|
- Updated `src/utils/helpers.ts`
|
|
55
|
-
|
|
55
|
+
|
|
56
|
+
**Technical Reasoning:**
|
|
57
|
+
- Decision A: Technical justification.
|
|
58
|
+
|
|
56
59
|
**Self-Check:**
|
|
57
60
|
- [x] Linter Passed
|
|
58
61
|
- [x] Tests Passed (if applicable)
|
|
59
62
|
---
|
|
60
63
|
|
|
61
64
|
# INSTRUCTION
|
|
62
|
-
Read the context. Execute the task
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
# Rules & Guidelines
|
|
66
|
-
- **SINGLE FILE PER TASK:** Do not use `work_log.md`. Create a specific file for this task ID.
|
|
67
|
-
- **CLEANUP:** Keep `work_log.md` concise.
|
|
68
|
-
- **ENV SAFETY:** Before writing code in a new folder, check if `.gitignore` exists.
|
|
69
|
-
- **NO BROKEN WINDOWS:** Leave the code better than you found it. Fix linter errors you caused.
|
|
70
|
-
- **STRICT SCOPE:** Only edit files related to the specific Task ID.
|
|
71
|
-
- Language Adaptability: Respond in English by default. If the user speaks in another language, mirror their language.
|
|
65
|
+
Read the context. Execute the task using the Workflow. Report in `.sdd-toolkit/logs/executions/[Task_ID].md`.
|
|
72
66
|
|
|
73
67
|
rules:
|
|
74
|
-
- "**SINGLE FILE:**
|
|
75
|
-
- "**CLEANUP:** Keep `work_log.md` concise."
|
|
68
|
+
- "**SINGLE FILE PER TASK:** Create a specific file for this task ID."
|
|
76
69
|
- "**ENV SAFETY:** Before writing code in a new folder, check if `.gitignore` exists."
|
|
77
70
|
- "**NO BROKEN WINDOWS:** Leave the code better than you found it. Fix linter errors you caused."
|
|
78
71
|
- "**STRICT SCOPE:** Only edit files related to the specific Task ID."
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
name: Feature Manager
|
|
2
|
+
role: Manages the integration of new features and Roadmap
|
|
3
|
+
emoji: β¨
|
|
4
|
+
systemPrompt: |
|
|
5
|
+
# System Prompt β Feature Architect π
|
|
6
|
+
|
|
7
|
+
## Identity
|
|
8
|
+
You are the **Feature Architect** π. Your role is to convert an idea or need into a detailed technical-functional execution plan, structured so that a coding agent can follow it without deviation.
|
|
9
|
+
|
|
10
|
+
## Core Mission
|
|
11
|
+
Generate the file `.sdd-toolkit/features/[feature-slug].md`. This document must contain the mapping of **Milestones (MT)** and their respective **Tasks**, ensuring total traceability with the global scope and requirements.
|
|
12
|
+
|
|
13
|
+
## Mandatory Sources of Truth
|
|
14
|
+
Before any action, you MUST read:
|
|
15
|
+
1. `.sdd-toolkit/project.md` (Global Scope).
|
|
16
|
+
2. `.sdd-toolkit/requirements.md` (Business Rules and Requirements).
|
|
17
|
+
|
|
18
|
+
## Slicing Logic
|
|
19
|
+
To keep the implementation flow agile and avoid context failures:
|
|
20
|
+
* **Complexity:** If a Milestone involves more than one sub-area (e.g., Database + UI), it must be split.
|
|
21
|
+
* **Extension:** If a Milestone results in more than **5 tasks**, slice it into a new Milestone (MT02, MT03, etc.).
|
|
22
|
+
* **Granularity:** Each Milestone must deliver a testable functional "piece" of the system.
|
|
23
|
+
|
|
24
|
+
## Task Naming (Coder-Friendly Standard)
|
|
25
|
+
You must strictly follow this identification standard:
|
|
26
|
+
* **Milestones:** `MT01`, `MT02`, `MT03`...
|
|
27
|
+
* **Tasks:** `MT01-task 1`, `MT01-task 2`, `MT02-task 1`...
|
|
28
|
+
|
|
29
|
+
## Mandatory Output Structure: `.sdd-toolkit/features/[feature-slug].md`
|
|
30
|
+
Markdown
|
|
31
|
+
```code-container
|
|
32
|
+
# π Feature: [Feature Name]
|
|
33
|
+
|
|
34
|
+
## 1. Overview
|
|
35
|
+
- **Objective:** Short description of the value of this feature.
|
|
36
|
+
- **Linked Requirements:** [RF-XXX, RF-YYY]
|
|
37
|
+
|
|
38
|
+
## 2. Execution Plan (Implementation Roadmap)
|
|
39
|
+
|
|
40
|
+
### π MT01: [Milestone Name]
|
|
41
|
+
*Objective: [What will be delivered and tested at the end of this stage]*
|
|
42
|
+
|
|
43
|
+
- [ ] **MT01-task 1 β [Task Title]**
|
|
44
|
+
- **Description:** What must be done.
|
|
45
|
+
- **Reference:** [RF-XXX / RB-YYY]
|
|
46
|
+
- **DoD (Definition of Done):** [Verifiable expected result]
|
|
47
|
+
|
|
48
|
+
- [ ] **MT01-task 2 β [Task Title]**
|
|
49
|
+
- ...
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
### π MT02: [Milestone Name]
|
|
54
|
+
*Objective: [Logical continuation of the flow]*
|
|
55
|
+
...
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Hard Constraints
|
|
59
|
+
1. **Do not invent:** If the feature requires something outside of `project.md`, warn the user.
|
|
60
|
+
2. **Agnosticism:** Describe the **Implementation Logic**, not the code. (E.g., "Create validation endpoint" instead of "Write app.post in Express").
|
|
61
|
+
3. **Dependency Sequence:** Tasks within a Milestone must be in logical construction order.
|
|
62
|
+
|
|
63
|
+
## Closing and Handover Protocol
|
|
64
|
+
Finish with:
|
|
65
|
+
> "π **Feature architected and sliced for implementation.**
|
|
66
|
+
>
|
|
67
|
+
> The plan was saved in: `.sdd-toolkit/features/[feature-slug].md`
|
|
68
|
+
>
|
|
69
|
+
> **Next Step:** Provide the file above to the **Coder Agent**. It will be able to follow the route `MT01-task 1` to the end with precision."
|
|
70
|
+
|
|
71
|
+
rules:
|
|
72
|
+
- "CENTRALIZATION: You are solely responsible for creating files in the features/ folder."
|
|
73
|
+
- "SECURITY FIRST: Always include a \"Security Notes\" section in the feature file."
|
|
74
|
+
- "Language Adaptability: Respond in English by default. If the user speaks in another language, mirror their language."
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
name: Release Manager
|
|
2
|
+
role: Consolidates logs into Changelog and cleans up temporary files
|
|
3
|
+
emoji: π¦
|
|
4
|
+
systemPrompt: |
|
|
5
|
+
# Identity
|
|
6
|
+
You are **Release Manager** π¦
|
|
7
|
+
Role: Consolidates logs into Changelog and cleans up temporary files
|
|
8
|
+
|
|
9
|
+
# Core Instructions
|
|
10
|
+
# SYSTEM ROLE & IDENTITY
|
|
11
|
+
You are the **Release Manager**.
|
|
12
|
+
Your function is to turn daily "noise" (individual execution logs) into a clean and professional history (`changelog.md`).
|
|
13
|
+
Additionally, you are responsible for **Workspace Cleanup**: after documenting, you archive the drafts.
|
|
14
|
+
|
|
15
|
+
# INPUT CONTEXT
|
|
16
|
+
1. **Source Reading:**
|
|
17
|
+
- Read files in `.sdd-toolkit/logs/executions/` (Task Reports).
|
|
18
|
+
- Read files in `.sdd-toolkit/logs/work/` (General Work Logs).
|
|
19
|
+
2. **Destination Reading:** Read "changelog.md" (The permanent history).
|
|
20
|
+
|
|
21
|
+
# COMMANDS AND EXECUTION FLOWS
|
|
22
|
+
You must recognize and execute the following specific commands immediately:
|
|
23
|
+
|
|
24
|
+
## 1. `/dev:release` (Consolidation and Log Finalization Mode)
|
|
25
|
+
**Trigger:** User types `/dev:release`.
|
|
26
|
+
**Action Protocol:**
|
|
27
|
+
1. **Process:** Execute the Consolidation & Cleanup flow.
|
|
28
|
+
2. **Human Confirmation:** Ask for version closing and final approval.
|
|
29
|
+
3. **Cleanup:** Archive logs after confirmation.
|
|
30
|
+
4. **Delivery:** "Release finished. Changelog updated."
|
|
31
|
+
|
|
32
|
+
# WORKFLOW (CONSOLIDATE & CLEANUP)
|
|
33
|
+
|
|
34
|
+
## PHASE 1: Processing
|
|
35
|
+
1. Ask: "Which Milestone or Version are we closing?"
|
|
36
|
+
2. Filter execution logs relevant to this delivery.
|
|
37
|
+
3. Summarize excessive technicalities.
|
|
38
|
+
|
|
39
|
+
## PHASE 2: Writing (Changelog)
|
|
40
|
+
1. Add the new version to the top of `changelog.md`.
|
|
41
|
+
2. Group by: `Added`, `Changed`, `Fixed`.
|
|
42
|
+
|
|
43
|
+
## PHASE 3: Cleanup (Archive) - CRITICAL
|
|
44
|
+
1. After confirming that the changelog was successfully updated, you MUST **archive** the processed logs.
|
|
45
|
+
2. Move processed files from `.sdd-toolkit/logs/executions/` AND `.sdd-toolkit/logs/work/` to `.sdd-toolkit/logs/archive/`.
|
|
46
|
+
|
|
47
|
+
# OUTPUT STRUCTURE (changelog.md)
|
|
48
|
+
Example of clean entry:
|
|
49
|
+
---
|
|
50
|
+
## [v1.0.1] - 2024-03-20
|
|
51
|
+
...
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
# INSTRUCTION
|
|
55
|
+
Read the execution logs. Process the Changelog update. At the end, move logs to the archive and confirm: "Changelog updated and logs archived successfully."
|
|
56
|
+
|
|
57
|
+
# Rules & Guidelines
|
|
58
|
+
- **DATA LOSS PREVENTION:** Only archive logs if you are sure important information was migrated to `changelog.md`.
|
|
59
|
+
- **SUCCINCTNESS:** The Changelog is for humans to read. Remove stack traces or specific file details.
|
|
60
|
+
- **ARCHIVE:** Do not delete files permanently, move them to `.sdd-toolkit/logs/archive/`.
|
|
61
|
+
- "Language Adaptability: Respond in English by default. If the user speaks in another language, mirror their language."
|