@daniel-da-silva-alves/sddk 2.0.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.
Files changed (31) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/LICENSE +21 -0
  3. package/README.md +260 -0
  4. package/bin/cli.js +430 -0
  5. package/package.json +49 -0
  6. package/sddk/plugin.json +12 -0
  7. package/sddk/skills/code-review/SKILL.md +185 -0
  8. package/sddk/skills/code-review/references/anti-ai-design-patterns.md +185 -0
  9. package/sddk/skills/code-review/references/refactoring-severity-guide.md +96 -0
  10. package/sddk/skills/code-review/references/security-checklist.md +131 -0
  11. package/sddk/skills/fullstack-development/SKILL.md +128 -0
  12. package/sddk/skills/fullstack-development/references/clean-code-rules.md +146 -0
  13. package/sddk/skills/fullstack-development/references/self-review-checklist.md +64 -0
  14. package/sddk/skills/implementation-planning/SKILL.md +102 -0
  15. package/sddk/skills/implementation-planning/references/manual-tests-template.md +95 -0
  16. package/sddk/skills/implementation-planning/references/microtask-template.md +66 -0
  17. package/sddk/skills/software-requirements-specification/SKILL.md +80 -0
  18. package/sddk/skills/software-requirements-specification/references/checklist-template.md +65 -0
  19. package/sddk/skills/software-requirements-specification/references/ieee-830-template.md +151 -0
  20. package/sddk/skills/software-requirements-specification/references/socratic-interview-guide.md +96 -0
  21. package/sddk/skills/system-design-document/SKILL.md +164 -0
  22. package/sddk/skills/system-design-document/references/architecture-patterns.md +105 -0
  23. package/sddk/skills/system-design-document/references/documentation-sources-guide.md +126 -0
  24. package/sddk/skills/system-design-document/references/sdd-template.md +259 -0
  25. package/sddk/skills/system-design-document/references/standards-api-template.md +128 -0
  26. package/sddk/skills/system-design-document/references/standards-architecture-template.md +76 -0
  27. package/sddk/skills/system-design-document/references/standards-coding-template.md +114 -0
  28. package/sddk/skills/system-design-document/references/standards-design-system-template.md +137 -0
  29. package/sddk/skills/system-design-document/references/standards-naming-template.md +96 -0
  30. package/sddk/skills/system-design-document/references/standards-onboarding-guide.md +119 -0
  31. package/sddk/skills/system-design-document/references/tech-stack-analysis.md +84 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,27 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [2.0.0] - 2026-06-02
9
+
10
+ ### Added
11
+ - **5-stage pipeline**: SRS → SDD → Planning → Dev → Code Review
12
+ - **Skill 1 — SRS**: Socratic interview with IEEE 830 compliance
13
+ - **Skill 2 — SDD**: System design with tech stack analysis and project standards onboarding
14
+ - **Skill 3 — Planning**: Phased microtasks with full traceability to SRS/SDD
15
+ - **Skill 4 — Dev**: Fullstack development with inline self-review and clean code enforcement
16
+ - **Skill 5 — Code Review**: 6-category audit with security checklist and anti-AI-design detection
17
+ - **CLI installer** (`sddk install`) with global and per-project modes
18
+ - **Project standards onboarding** generating 5 reusable standards files
19
+ - **Documentation sources hierarchy** for version-pinned tech documentation
20
+ - **Anti-AI-design patterns** detection (8 patterns)
21
+ - **Manual test scenarios** generation
22
+
23
+ ### Changed
24
+ - Complete rewrite from v1.0.0
25
+ - Restructured plugin to use `skills/` directory with `SKILL.md` + `references/` pattern
26
+
27
+ [2.0.0]: https://github.com/Daniel-da-Silva-Alves/Spec-Driven-Development-Kit/releases/tag/v2.0.0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 SDDK Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,260 @@
1
+ <!-- prettier-ignore -->
2
+ <div align="center">
3
+
4
+ <img src="./docs/sddk.svg" alt="SDDK Logo" height="200" />
5
+
6
+ # Spec-Driven Development Kit (SDDK)
7
+
8
+ *An AI agent plugin that enforces disciplined software engineering through a 5-stage specification-driven pipeline.*
9
+
10
+ [![Version](https://img.shields.io/badge/version-2.0.0-blue?style=flat-square)](https://github.com/Daniel-da-Silva-Alves/Spec-Driven-Development-Kit)
11
+ [![Plugin](https://img.shields.io/badge/type-AI_Agent_Plugin-8B5CF6?style=flat-square)]()
12
+ [![Pipeline](https://img.shields.io/badge/stages-5_Skills-10B981?style=flat-square)]()
13
+ [![Standard](https://img.shields.io/badge/spec-IEEE_830-3B82F6?style=flat-square)]()
14
+
15
+ [Overview](#overview) • [The Pipeline](#the-pipeline) • [Installation](#installation) • [Usage](#usage) • [Project Structure](#project-structure) • [Features](#features)
16
+
17
+ </div>
18
+
19
+ ---
20
+
21
+ ## Overview
22
+
23
+ **SDDK** is a plugin for AI coding agents (Gemini, Claude, and other IDE-integrated agents) that transforms how AI writes software. Instead of letting the agent jump straight into code, SDDK enforces a **rigorous 5-stage engineering pipeline** — from requirements elicitation through code review — ensuring that every line of code is traceable, well-architected, and production-grade.
24
+
25
+ The core problem SDDK solves: AI agents tend to produce **"tutorial-quality" code** — functional but poorly structured, undocumented, and difficult to maintain. SDDK forces the agent to behave like a **senior engineering team**, producing formal specifications before writing a single line of code.
26
+
27
+ > [!IMPORTANT]
28
+ > SDDK is **not a code generator**. It's a **process enforcer** — a set of 5 sequential skills that guide an AI agent through the same disciplined workflow a professional engineering team would follow.
29
+
30
+ ## The Pipeline
31
+
32
+ SDDK guides the AI agent through 5 sequential stages. Each stage must be completed and approved before advancing to the next:
33
+
34
+ ```mermaid
35
+ graph LR
36
+ SRS["1. SRS<br>Requirements"]
37
+ SDD["2. SDD<br>Architecture"]
38
+ PLAN["3. Planning<br>Microtasks"]
39
+ DEV["4. Dev<br>Fullstack"]
40
+ CR["5. Code Review<br>Audit"]
41
+
42
+ SRS --> SDD --> PLAN --> DEV --> CR
43
+
44
+ style SRS fill:#3B82F6,stroke:#1E40AF,color:#fff
45
+ style SDD fill:#8B5CF6,stroke:#5B21B6,color:#fff
46
+ style PLAN fill:#10B981,stroke:#047857,color:#fff
47
+ style DEV fill:#F59E0B,stroke:#B45309,color:#fff
48
+ style CR fill:#EF4444,stroke:#B91C1C,color:#fff
49
+ ```
50
+
51
+ | Stage | Skill | Agent Role | Output |
52
+ |:---:|:---|:---|:---|
53
+ | 1 | **Software Requirements Specification** | Senior Requirements Engineer | `srs.md` — Formal requirements doc (IEEE 830) |
54
+ | 2 | **System Design Document** | Senior Software Architect | `sdd.md` — Architecture, stack, data model, API design |
55
+ | 3 | **Implementation Planning** | Senior Tech Lead | `implementation_plan` — Phased microtasks with traceability |
56
+ | 4 | **Fullstack Development** | Senior Fullstack Developer | Production code following specs + inline self-review |
57
+ | 5 | **Code Review** | Senior Reviewer & Security Auditor | Audit report + refactoring backlog |
58
+
59
+ ## Installation
60
+
61
+ ### Prerequisites
62
+
63
+ - An AI coding agent that supports plugins/skills (e.g., Gemini in VS Code, Claude, or compatible IDE agents)
64
+ - A workspace/project where you want to apply the SDDK pipeline
65
+
66
+ ### Setup
67
+
68
+ 1. Clone this repository:
69
+ ```bash
70
+ git clone https://github.com/Daniel-da-Silva-Alves/Spec-Driven-Development-Kit.git
71
+ ```
72
+
73
+ 2. Copy the `sddk` folder into your agent's plugin directory:
74
+ ```
75
+ # Example for Gemini in VS Code:
76
+ cp -r sddk/ ~/.gemini/config/plugins/sddk/
77
+
78
+ # Or on Windows:
79
+ xcopy /E /I sddk %USERPROFILE%\.gemini\config\plugins\sddk
80
+ ```
81
+
82
+ 3. Restart your IDE. The agent will automatically detect the 5 skills.
83
+
84
+ > [!TIP]
85
+ > You can verify the installation by asking your agent: *"What skills do you have available?"* — it should list the 5 SDDK skills.
86
+
87
+ ## Usage
88
+
89
+ ### Starting the Pipeline
90
+
91
+ To begin, simply describe the feature you want to build. Use natural language — the agent will activate the first skill (SRS) and guide you through the process:
92
+
93
+ ```
94
+ You: "I want to create an authentication feature with email/password and OAuth"
95
+ Agent: "I'll conduct an interview to fully specify this feature. Let's go topic by topic..."
96
+ ```
97
+
98
+ ### Stage 1 — Requirements Specification (SRS)
99
+
100
+ The agent acts as a **Senior Requirements Engineer** and conducts a **Socratic interview** — asking one question at a time to eliminate ambiguity:
101
+
102
+ ```
103
+ Agent: "What should happen when a user enters an incorrect password 3 times?"
104
+ a) Lock the account for 15 minutes
105
+ b) Lock the account until admin reset
106
+ c) Show CAPTCHA
107
+ d) Other
108
+
109
+ You: (select your choice)
110
+ ```
111
+
112
+ After all questions are answered, the agent generates a formal **SRS document** following IEEE 830 and saves it to:
113
+ ```
114
+ .specs/features/{feature-name}/srs.md
115
+ ```
116
+
117
+ ### Stage 2 — System Design Document (SDD)
118
+
119
+ The agent shifts to **Senior Software Architect** and conducts a technical interview covering:
120
+
121
+ - Stack selection and validation
122
+ - Architecture pattern (MVC, Clean Architecture, Hexagonal, etc.)
123
+ - Data model and persistence strategy
124
+ - API design (endpoints, request/response formats)
125
+ - Frontend componentization and state management
126
+ - Documentation sources for each technology
127
+
128
+ > [!NOTE]
129
+ > On first run, the agent will also conduct a **project standards onboarding**, generating reusable standards in `.specs/standards/` (architecture, naming conventions, design system, API conventions, coding standards). These apply to **all features** going forward.
130
+
131
+ Output: `.specs/features/{feature-name}/sdd.md`
132
+
133
+ ### Stage 3 — Implementation Planning
134
+
135
+ The agent becomes a **Senior Tech Lead** and decomposes the work into **phased microtasks**, ordered by dependency layer:
136
+
137
+ 1. Configuration and setup
138
+ 2. Data model / migrations
139
+ 3. Data access layer (repositories)
140
+ 4. Business logic (services)
141
+ 5. API / endpoints
142
+ 6. UI components
143
+ 7. Integration between layers
144
+ 8. Polish and edge cases
145
+
146
+ Each microtask includes:
147
+ - References to specific SRS requirements (`RF-001`, `RF-002`, ...)
148
+ - References to specific SDD sections (with file links and line numbers)
149
+ - References to project standards
150
+ - List of files to create/modify
151
+ - Clear "definition of done"
152
+
153
+ The agent also generates **manual test scenarios** in `.specs/features/{feature-name}/manual-tests.md`.
154
+
155
+ ### Stage 4 — Fullstack Development
156
+
157
+ The agent executes as a **Senior Fullstack Developer**, implementing one microtask at a time:
158
+
159
+ - Reads only the referenced SRS/SDD sections for each task (optimized context usage)
160
+ - Follows clean code rules — no generic names, no obvious comments, no boilerplate
161
+ - Applies **anti-AI-design patterns** — no emojis in UI, no generic CSS, no placeholder text
162
+ - Performs **inline self-review** after each microtask before marking it complete
163
+ - Consults official documentation following the priority hierarchy defined in the SDD
164
+
165
+ ### Stage 5 — Code Review
166
+
167
+ The agent performs a comprehensive audit as a **Senior Code Reviewer & Security Auditor**, checking 6 categories:
168
+
169
+ | Category | What it checks |
170
+ |:---|:---|
171
+ | Code Quality | Clean code, naming conventions, anti-AI patterns, component granularity |
172
+ | Security | Input validation, injection vulnerabilities, CORS, hardcoded secrets |
173
+ | SDD Adherence | Architecture layers, data model, API design, design tokens |
174
+ | Componentization | Reusable components, design system consistency, responsiveness |
175
+ | API Usage | Correct API versions, non-deprecated patterns, proper imports |
176
+ | Standards Compliance | All `.specs/standards/` rules enforced |
177
+
178
+ Issues are classified by severity:
179
+ - **Critical** — fixed immediately (security, breaking bugs, SDD violations)
180
+ - **Medium/Low** — documented in `.specs/features/{feature-name}/refactoring-backlog.md`
181
+
182
+ ### Generated Project Artifacts
183
+
184
+ After completing the pipeline, your project will contain:
185
+
186
+ ```
187
+ .specs/
188
+ ├── standards/ # Project-wide standards (generated once)
189
+ │ ├── architecture.md
190
+ │ ├── naming-conventions.md
191
+ │ ├── design-system.md
192
+ │ ├── api-conventions.md
193
+ │ └── coding-standards.md
194
+ └── features/
195
+ └── {feature-name}/
196
+ ├── srs.md # Stage 1 — Requirements specification
197
+ ├── sdd.md # Stage 2 — System design document
198
+ ├── manual-tests.md # Stage 3 — Test scenarios
199
+ └── refactoring-backlog.md # Stage 5 — Non-critical improvements
200
+ ```
201
+
202
+ ## Project Structure
203
+
204
+ ```
205
+ Spec-Driven-Development-Kit/
206
+ ├── bin/
207
+ │ └── cli.js # CLI installer (zero dependencies)
208
+ ├── sddk/
209
+ │ ├── plugin.json # Plugin manifest
210
+ │ └── skills/
211
+ │ ├── software-requirements-specification/
212
+ │ │ ├── SKILL.md # Skill 1 — SRS
213
+ │ │ └── references/
214
+ │ │ ├── ieee-830-template.md
215
+ │ │ ├── socratic-interview-guide.md
216
+ │ │ └── checklist-template.md
217
+ │ ├── system-design-document/
218
+ │ │ ├── SKILL.md # Skill 2 — SDD
219
+ │ │ └── references/
220
+ │ │ ├── sdd-template.md
221
+ │ │ ├── architecture-patterns.md
222
+ │ │ ├── tech-stack-analysis.md
223
+ │ │ ├── documentation-sources-guide.md
224
+ │ │ ├── standards-onboarding-guide.md
225
+ │ │ └── standards-*-template.md # 5 standards templates
226
+ │ ├── implementation-planning/
227
+ │ │ ├── SKILL.md # Skill 3 — Planning
228
+ │ │ └── references/
229
+ │ │ ├── microtask-template.md
230
+ │ │ └── manual-tests-template.md
231
+ │ ├── fullstack-development/
232
+ │ │ ├── SKILL.md # Skill 4 — Dev
233
+ │ │ └── references/
234
+ │ │ ├── self-review-checklist.md
235
+ │ │ └── clean-code-rules.md
236
+ │ └── code-review/
237
+ │ ├── SKILL.md # Skill 5 — Code Review
238
+ │ └── references/
239
+ │ ├── anti-ai-design-patterns.md
240
+ │ ├── security-checklist.md
241
+ │ └── refactoring-severity-guide.md
242
+ ├── docs/
243
+ │ ├── sddk.svg # Project logo
244
+ │ └── agent-workflow-sdd.pdf # Pipeline workflow diagram
245
+ └── .github/ # Issue & PR templates
246
+ ```
247
+
248
+ ## Features
249
+
250
+ - **Socratic Requirements Elicitation** — The agent interviews you question-by-question, challenging vague answers and detecting ambiguities before anything is built
251
+ - **IEEE 830 / ISO 29148 Compliance** — Requirements documents follow formal standards, not ad-hoc notes
252
+ - **Full Traceability** — Every microtask traces back to specific SRS requirements and SDD sections with file links and line numbers
253
+ - **Project Standards Onboarding** — On first use, the agent establishes reusable standards (architecture, naming, design system, API, coding) that apply to all future features
254
+ - **Anti-AI-Design Detection** — The code review skill actively detects and rejects 8 common patterns of sloppy AI-generated code (emojis in UI, generic CSS, placeholder text, monolithic components, etc.)
255
+ - **Security Audit Built-In** — Every feature goes through a security checklist covering injection, CORS, secrets, auth, and input validation
256
+ - **Documentation-First Development** — The agent consults official docs (with version pinning) instead of relying on potentially stale training data
257
+ - **Optimized Context Usage** — The dev skill reads only the specific SRS/SDD sections referenced by each microtask, not the entire document
258
+
259
+ > [!WARNING]
260
+ > SDDK is designed for **feature-level development**. Each run of the pipeline specifies, designs, plans, implements, and reviews a single feature. For multi-feature projects, run the pipeline once per feature.