@edupia-tutor/spec-driven-docs 0.14.0

package/skills/spec/SKILL.tmpl

@@ -0,0 +1,174 @@
+---
+description: Generates BDD .feature files from an approved PRD, or generates technical design documents. Trigger when: "/generate-bdd", "/generate-tech-docs", "tạo BDD", "tạo spec", "generate feature file", "write BDD scenarios", "tạo technical design", "tech design", "sinh tech docs", "API design", "sinh .feature".
+---
+
+# Spec Skills — BDD & Technical Design
+
+This skill handles two commands: `/generate-bdd` to create BDD feature files, and `/generate-tech-docs` to create technical design documents.
+
+---
+
+## /generate-bdd — Generate BDD Feature Files
+
+### Gate
+
+<!-- Directory: specs/*/*/prd.md -->
+{{include:steps/gate.md}}
+
+Also verify: Check that the PRD `Status` is `approved` (not `draft`).
+- If `draft`: warn "PRD is still draft. Proceed anyway? Findings from /refine-prd may not be addressed yet."
+
+### UC Decomposition
+
+For each Use Case in the PRD, derive scenarios. Present outline:
+
+```
+{DOMAIN}-UC1: {Name}
+  SC1: Happy path — {client/role type} — {success scenario}
+  SC2: Happy path — {other client/role type} (if applicable)
+  SC3: Validation error — {invalid input}
+  SC4: Not found / resource missing
+  BRs covered: BR-1, BR-2
+
+{DOMAIN}-UC2: {Name}
+  ...
+```
+
+**CHECKPOINT** — Ask: "Does this outline look correct? Any missing scenarios?"
+Wait for confirmation before generating files.
+
+### Generate
+
+For each UC, write `specs/{domain}/{prd-slug}/bdd/{UC-ID}-{slug}.feature`:
+
+```gherkin
+# @trace.source=specs/{domain}/{prd-slug}/prd.md
+# @trace.uc={UC-ID}
+Feature: {UC Name}
+
+  Background:
+    Given the system is running
+    And a {persona} is authenticated
+
+  Scenario: SC1 — {Happy path description}
+    Given {precondition}
+    When {action}
+    Then {expected outcome}
+    And {secondary outcome if any}
+
+  Scenario: SC2 — {Another happy path}
+    Given {precondition}
+    When {action}
+    Then {expected outcome}
+
+  Scenario: SC3 — Validation error
+    Given {precondition}
+    When {invalid action}
+    Then the system returns a validation error
+    And the error message mentions "{field}"
+
+  Scenario: SC4 — Resource not found
+    Given no {resource} exists with id {id}
+    When {action}
+    Then the system returns a not-found error
+```
+
+### Quality Check
+
+After generating, self-evaluate:
+- [ ] Every acceptance criteria from PRD has at least one scenario
+- [ ] Every business rule is covered by at least one scenario
+- [ ] Error scenarios are present (validation, not-found, unauthorized)
+- [ ] Scenarios are atomic (one behavior per scenario)
+- [ ] No implementation details in feature files (no SQL, no class names)
+
+### Output
+
+```
+/generate-bdd Complete — {domain}
+
+Files created:
+  ✅ specs/{domain}/{prd-slug}/bdd/{UC-ID}-{slug}.feature ({N} scenarios)
+  ...
+
+Quality: {score}%
+```
+
+{{include:steps/report-footer.md}}
+
+---
+
+## /generate-tech-docs — Generate Technical Design Document
+
+### Gate
+
+Check BDD quality (read .feature files, verify scenarios are well-formed).
+If quality < 80%, halt and report: "BDD quality insufficient. Fix these issues first: [list]"
+
+### Generate
+
+Write `specs/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md`:
+
+```markdown
+# Technical Design — {UC-ID}: {Feature}
+
+**Domain**: {domain}
+**Date**: {date}
+**Spec**: specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature
+
+## §1. Overview
+{Brief description of what this UC implements}
+
+## §2. API Endpoints
+
+| Method | Path | Auth/Role | Request Body | Response |
+|--------|------|-----------|--------------|----------|
+| GET    | /v1/{resource} | {role} | — | {ResponseDTO} |
+| POST   | /v1/{resource} | {role} | {RequestDTO} | {ResponseDTO} |
+
+## §3. Data Model
+
+{Entity diagram or table structure}
+
+Key entities:
+- `{Entity}`: {description, key fields}
+
+## §4. Service Flow
+
+Sequence for each UC:
+```
+{Client} → Controller → {Facade} → {Service} → {Repository}
+                              ↓
+                    {OtherService} (if cross-service)
+```
+
+## §5. Business Rules Implementation
+
+| BR-ID | Rule | Implementation approach |
+|-------|------|------------------------|
+| BR-1 | {rule} | {how to implement} |
+
+## §6. Error Handling
+
+| Scenario | Exception | HTTP Status |
+|----------|-----------|-------------|
+| {resource} not found | {NotFoundException} | 404 |
+| Validation failure | {ValidationException} | 400 |
+| Unauthorized | {AuthException} | 403 |
+
+## §7. Database Changes
+
+{Migration script or schema changes needed}
+
+## §8. Caching Strategy
+
+{Which data to cache, TTL, invalidation triggers — or "N/A"}
+
+## §9. Cross-Service Dependencies
+
+{List external service calls, event producers/consumers}
+```
+
+Instruct: "SA/Lead should review and approve before running /generate-code."
+
+{{include:steps/report-footer.md}}