@edupia-tutor/spec-driven-docs 0.14.0

package/commands/generate-design-spec.tmpl

@@ -0,0 +1,464 @@
+# /generate-design-spec — Generate Design Specification (FE / App)
+
+## Gate
+{{include:steps/gate.md}}
+
+*Note: For this command, the target file is a Business PRD (`prd.md`) under `{paths.specs_dir}/{domain}/{prd-slug}/`. Resolve from `$ARGUMENTS` or list the directory and ask. Only FE and mobile PRDs are supported — BE PRDs will be rejected at the Platform Check step.*
+
+## Context
+{{include:steps/context-loader.md}}
+
+*Additional context for this command: Read the full target PRD. Extract: **TICKET-ID**, **domain**, **feature name**, **Service** and **Module** from PRD metadata (rows `| **Service** |` and `| **Module** |`), User Flow (Section 4a), and Wireframe screen names (Section 4b).*
+
+*Service extraction rules (same as /generate-prd):*
+- *If PRD metadata has `| **Service** |` → use as `active_service` and `| **Module** |` as `active_module`.*
+- *If absent AND `services` defined in `project-context.yaml` → ask: "Which service is this Design Spec for?" (list FE/App services only, wait for selection).*
+- *If single-service project → `active_service = "default"`, `active_module = tech_stack.module`.*
+
+---
+
+## Platform Check
+
+Using `active_module` and `platform_type` derived from context loading:
+
+1. If `platform_type = "backend"` → **STOP**. Output:
+   ```
+   ❌ Design Spec is only for FE and mobile platforms.
+   For BE services, API contracts belong in the Business PRD (Use Case → Business Logic section).
+   ```
+
+2. If `platform_type = "web-frontend"` → set `active_platform = "web"`.
+
+3. If `platform_type = "mobile"`:
+   - `flutter` or `react-native` → set `active_platform = "app"`
+   - `ios-swiftui` → set `active_platform = "app-ios"`
+   - `android-compose` → set `active_platform = "app-android"`
+
+4. If `platform_type = "unknown"` → ask: "Which platform is this Design Spec for?"
+   ```
+   Options:
+     1 — web    (React / Next.js / Vue / Angular)
+     2 — app    (Flutter / React Native)
+     3 — app-ios     (iOS SwiftUI)
+     4 — app-android (Android Compose)
+   ```
+   Wait for selection. Map choice to `active_platform` and infer `active_module` if possible.
+
+---
+
+## Screen Discovery
+
+From the PRD's Section 4 (User Flow + Wireframe), extract all screen / page / modal names mentioned.
+
+Present the list and ask PO to confirm:
+
+```
+Screens detected from PRD:
+  1. {Screen name 1}
+  2. {Screen name 2}
+  ...
+
+Are these all the screens for the {active_platform} platform?
+Add any missing, remove any that don't apply, or confirm with Y.
+```
+
+Wait for confirmation. Store the confirmed list as `screen_list`.
+
+---
+
+## Figma Frame Links *(mandatory — one readable node-level link per screen)*
+
+A Design Spec is only as good as the design it points to. The AI **cannot read a plain
+file link** (`figma.com/design/{fileKey}/...` with no `node-id`) — it needs a
+**node-level link to each specific frame** so it can fetch that frame's real layout,
+components, and tokens via the Figma MCP. So collect one link **per screen**, not one
+link for the whole feature.
+
+**Ask the PO, listing every screen in `screen_list`:**
+
+```
+Paste the Figma frame link for each screen below.
+
+  In Figma: select the frame → right-click → "Copy link to selection"
+  (the URL must contain  ?node-id=...  — that is the per-frame link the AI can read)
+
+  1. {Screen 1} : ____
+  2. {Screen 2} : ____
+  ...
+
+If a screen has no design yet, type  none  for that screen.
+```
+
+**For each answer:**
+
+1. **Validate format** — the URL must match `figma.com/design/{fileKey}/...?node-id={nodeId}`.
+   - Valid → store as `figma_frames[{screen}] = {url}`, parse out `fileKey` + `nodeId`.
+   - A file link with **no `node-id`** → reject it: "This link points to the whole file, not a frame. Re-copy via right-click → Copy link to selection." Re-ask for that screen.
+   - `none` → `figma_frames[{screen}] = "TBD"`, mark that screen ❌ Missing.
+
+2. **Fetch the frame via Figma MCP** (only for valid links) — call `get_design_context`
+   (and `get_screenshot` when useful) with the parsed `fileKey` + `nodeId` to read the
+   real layout, component names, and design tokens. Ground every Screen Spec in this
+   fetched data; do **not** invent layout the frame does not show. If a fetch fails
+   (permission / not found) → treat that screen as ❌ Missing and note the fetch error.
+
+3. Derive the feature-level `figma_url` = the file link (without `node-id`) shared by the
+   frames, for the Metadata row. If frames span multiple files, list each.
+
+**Mandatory gate (does not abort — produces a draft):**
+- If **any** screen is ❌ Missing → the spec is generated as a **draft** with those screens
+  flagged, but `Status` stays `draft` and **sign-off / `/generate-bdd` is blocked** until
+  every screen has a readable, fetched frame link. Record `missing_frames = [screens]`.
+- Add one AI Assumption per missing screen: "No readable Figma frame for {screen} — spec
+  for this screen is text-only and must not be signed off until a `node-id` link is added."
+
+---
+
+## CHECKPOINT
+
+```
+CHECKPOINT — Design Spec
+-------------------------
+Target PRD  : {prd-file-path}
+Platform    : {active_platform}
+Module      : {active_module}
+Service     : {active_service}
+Domain      : {domain}
+Screens     : {N} — {comma-separated screen_list}
+Figma       : {linked}/{N} screens have readable frame links{; missing: comma-separated missing_frames}
+Output path : {paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md
+
+{If missing_frames non-empty}:
+⚠️  {count} screen(s) without a readable Figma frame link — these will be generated as
+   text-only drafts and the spec cannot be signed off until their node-id links are added.
+
+Generate? (Y/N)
+```
+
+Wait for explicit Y before proceeding.
+
+---
+
+## Generation Rules
+
+Apply these rules consistently when generating all sections:
+
+**Component mapping (C.M — mandatory):**
+- For each component referenced, check `figma-components/{active_module}.md` (loaded in context).
+- ✅ Matched → use the exact `Code Component` and `Import Path` from the catalog.
+- ⚠️ Matched but `[TODO]` → mark the component cell as `[TODO — implementation pending]`.
+- ❌ Not in catalog → mark as `[NEW — confirm with designer before generating code]`.
+- Never invent component names or import paths.
+
+**Platform-adaptive sections:**
+- Section 3 (Interaction Patterns) and Section 4 (Platform Considerations) adapt to `active_platform`:
+  - `web` → include responsive breakpoints, hover/focus states, keyboard navigation, accessibility.
+  - `app` / `app-ios` / `app-android` → include gestures, safe area, minimum touch targets, navigation pattern, deep links, permissions, offline behavior.
+  - Only generate the section relevant to `active_platform`. Omit the other platform's section entirely.
+
+**Figma grounding (mandatory):**
+- For every screen with a fetched frame (`figma_frames[screen]` is a valid link), base the
+  Layout, Component Inventory, and Screen States on the **fetched Figma data** — real
+  component names, real tokens, real frame structure. Do not contradict or invent layout.
+- Use the exact per-screen `figma_frames[screen]` URL in the Screen Inventory, each Screen
+  Spec header, and the Figma Summary — never a synthetic `{figma_url}#screen1` fragment.
+- For ❌ Missing screens: generate a text-only draft from the PRD, prefix the Screen Spec
+  with `> [DRAFT — no Figma frame; do not sign off]`, and leave the Figma cell as ❌ Missing.
+
+**Screen states (mandatory per screen):**
+- Every screen must document at minimum: `default`, `loading`, `error`.
+- Add `empty` when the screen can display zero-data state.
+- Add `success` when a completed action produces a distinct confirmation state.
+- If a state does not apply → mark `N/A` with a short reason.
+
+---
+
+## Generate
+
+Write `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md`:
+
+````markdown
+# {TICKET-ID} {Feature Name} — Design Spec [{active_platform}]
+
+---
+
+## Metadata
+
+| Field              | Value                                                         |
+|--------------------|---------------------------------------------------------------|
+| **Spec ID**        | {TICKET-ID}-DS-{active_platform}                              |
+| **Version**        | 1.0                                                           |
+| **Status**         | draft                                                         |
+| **Platform**       | {active_platform}                                             |
+| **Module**         | {active_module}                                               |
+| **Service**        | {active_service}                                              |
+| **Domain**         | {domain}                                                      |
+| **Business PRD**   | [{TICKET-ID}]({relative-path-to-prd.md})                      |
+| **Figma**          | {figma_url — feature file link} ({linked}/{N} frames linked)  |
+| **Author**         | {PO name or "AI-assisted"}                                    |
+| **Created**        | {YYYY-MM-DD}                                                  |
+| **Updated**        | {YYYY-MM-DD}                                                  |
+
+---
+
+# 1. Screen Inventory
+
+| # | Screen Name | Entry Point | Figma Frame | Notes |
+|---|-------------|-------------|-------------|-------|
+| 1 | {Screen 1}  | {how user arrives — e.g., tap CTA on Home} | [Frame]({figma_frames[Screen 1]}) | |
+| 2 | {Screen 2}  | {entry point} | [Frame]({figma_frames[Screen 2]}) / ❌ Missing | |
+
+---
+
+# 2. Screen Specs
+
+<!--
+  Repeat this block for every screen in the Screen Inventory.
+  Each screen must have: Layout, Component Inventory, Screen States, Actions & Navigation.
+-->
+
+## Screen 1: {Screen Name}
+
+**Figma**: [{Frame name}]({figma_frames[Screen 1]})   <!-- ❌ Missing → prefix this screen with `> [DRAFT — no Figma frame; do not sign off]` -->
+
+### Layout
+
+{Describe the layout: grid columns, max-width container, section order, padding, key spacing values.
+ Reference design tokens where applicable (e.g., `spacing.md = 16px`, `color.surface`).}
+
+### Component Inventory
+
+| Component (Figma)   | Code Component  | Import Path            | States                          | Notes              |
+|---------------------|-----------------|------------------------|---------------------------------|--------------------|
+| {Figma/Button/Primary} | Button       | @/components/ui/Button | default, loading, disabled      |                    |
+| {Figma/Input/Text}  | TextInput       | @/components/ui/Input  | default, focus, error, disabled |                    |
+| {Figma/Card/Order}  | OrderCard       | @/features/{domain}/components/OrderCard | default, skeleton |           |
+
+### Screen States
+
+| State     | Trigger                             | UI Behavior                                                  |
+|-----------|-------------------------------------|--------------------------------------------------------------|
+| default   | Screen loaded, data available       | {Describe full rendered appearance}                          |
+| loading   | API call in flight                  | {Skeleton layout / spinner position — reference component}   |
+| error     | API failure or validation error     | {Toast / inline message / error screen — exact copy TBD}     |
+| empty     | API returns empty list / no data    | {Empty state illustration + CTA text — e.g., "No orders yet. Start shopping →"} |
+| success   | Action completed (if applicable)    | {Confirmation message / navigation / state change}           |
+
+### Actions & Navigation
+
+| Action          | Trigger                        | Result                                          |
+|-----------------|--------------------------------|-------------------------------------------------|
+| {Action name}   | Tap/click {element name}       | Navigate to {Screen N} / Open {Modal name}      |
+| {Action name}   | Swipe left on {list item}      | Show delete confirmation                        |
+| {Back / Cancel} | Back gesture / Cancel button   | Return to {previous screen} without saving      |
+
+---
+
+<!--  Repeat ## Screen N block for each additional screen  -->
+
+---
+
+# 3. Interaction Patterns
+
+<!--
+  Web platform: include sections A + B. Remove section C.
+  App platform: include section C. Remove sections A + B.
+-->
+
+<!-- ═══════════════════════════ WEB ONLY ═══════════════════════════ -->
+
+## A. Responsive Behavior  *(web only)*
+
+| Breakpoint | Width      | Layout Changes                                     |
+|------------|------------|----------------------------------------------------|
+| Mobile     | < 768px    | {Single column, bottom navigation bar, CTA full-width} |
+| Tablet     | 768–1279px | {2-column grid, sidebar collapsed, tab navigation} |
+| Desktop    | ≥ 1280px   | {Full layout, sidebar visible, max-width 1440px}   |
+
+## B. Hover / Focus / Keyboard  *(web only)*
+
+| Element        | Hover state                   | Focus state                     | Keyboard shortcut |
+|----------------|-------------------------------|---------------------------------|-------------------|
+| Primary button | Background → {color.hover}    | Outline 2px {color.focus}       | Enter / Space     |
+| Text input     | Border → {color.border.hover} | Border → {color.primary}, label floats | Tab to focus |
+| Dropdown       | Background highlight          | Same as hover + ring            | Arrow keys to navigate |
+
+<!-- ═══════════════════════════ APP ONLY ═══════════════════════════ -->
+
+## C. Gestures & Navigation  *(app only)*
+
+| Gesture           | Screen / Element          | Behavior                                              |
+|-------------------|---------------------------|-------------------------------------------------------|
+| Back gesture (iOS swipe-right / Android back) | All screens | {Return to previous screen / Show "Discard changes?" dialog} |
+| Pull-to-refresh   | {Screen names}            | Refresh data, spinner at top                          |
+| Swipe left on row | {List item name}          | Reveal {Delete / Archive} action                      |
+| Long press        | {Element name}            | {Context menu / selection mode}                       |
+| Pinch / zoom      | {Image viewer}            | Scale image, double-tap to reset                      |
+
+### Navigation Pattern  *(app only)*
+
+```
+{Draw the navigation stack for this feature, e.g.:
+  BottomTab(Home) → FeatureListPage → FeatureDetailPage → EditPage
+  BottomTab(Home) → FeatureListPage ↘ (modal) CreatePage
+}
+```
+
+Entry: {how the user enters this feature — tab / deeplink / push from another screen}
+Exit: {how the user leaves — back stack / tab switch / deeplink out}
+
+### Platform Conventions  *(app only)*
+
+| Aspect                   | iOS behavior                            | Android behavior                        |
+|--------------------------|-----------------------------------------|-----------------------------------------|
+| Navigation bar           | {Back button top-left, title centered}  | {Up arrow top-left, title left-aligned} |
+| Sheet / bottom modal     | {UISheetPresentation, grabber visible}  | {BottomSheet, drag handle}              |
+| Alert / confirm dialog   | {UIAlertController, actions right-aligned} | {Material AlertDialog, actions left-aligned} |
+| Loading indicator        | {UIActivityIndicatorView, center}       | {CircularProgressIndicator}             |
+| Toast / snackbar         | {Custom toast, bottom center}           | {Material Snackbar, bottom}             |
+
+---
+
+# 4. Platform Considerations
+
+<!--
+  Web: include section A. App: include section B. Remove the non-applicable section.
+-->
+
+<!-- ═══════════════════════════ WEB ONLY ═══════════════════════════ -->
+
+## A. Accessibility  *(web only)*
+
+- [ ] All interactive elements reachable via Tab key — no keyboard traps
+- [ ] Focus trap inside modal dialogs (Tab cycles within modal only)
+- [ ] Icon-only buttons have `aria-label` describing the action
+- [ ] Dynamic content updates (loading → loaded) announce via `aria-live`
+- [ ] Color contrast meets WCAG AA: text ≥ 4.5:1, large text ≥ 3:1
+- [ ] Form inputs have visible labels (not placeholder-only)
+- [ ] Error messages linked to inputs via `aria-describedby`
+
+<!-- ═══════════════════════════ APP ONLY ═══════════════════════════ -->
+
+## B. Device & OS  *(app only)*
+
+- [ ] Safe area insets applied on all screens — top (status bar) and bottom (home indicator)
+- [ ] Minimum touch target: 44×44pt (iOS) / 48×48dp (Android)
+- [ ] Tested on small screen: 375pt wide (iPhone SE) / 360dp wide (common Android)
+- [ ] Deep link entry: `{scheme}://{host}/{path}` → lands on {screen name} with {param} pre-filled
+- [ ] Permission gates: {list permissions needed — Camera / Location / Notification}
+  - {Permission}: requested on {screen name} with rationale copy: "{copy TBD}"
+- [ ] Offline / no-network behavior:
+  - {Screen name}: show cached data + offline banner
+  - {Action name}: disable button, show tooltip "Requires connection"
+- [ ] Dark mode: all screens tested in dark mode — no hardcoded colors
+
+---
+
+# 5. AC-UI — Design Acceptance Criteria
+
+> Reviewed and signed off by **PO + Designer** together before BDD generation.
+> These complement (not replace) the business-level AC in the [Business PRD]({prd-path}).
+
+| ID     | Acceptance Criterion                                                           | Verified by     |
+|--------|--------------------------------------------------------------------------------|-----------------|
+| AC-UI1 | All screens match approved Figma frames within design-system tolerances        | Designer        |
+| AC-UI2 | Loading skeleton/spinner appears within 200ms of initiating any API call       | QA              |
+| AC-UI3 | All error messages are visible, descriptive, and include a recovery action     | PO              |
+| AC-UI4 | Empty states include an illustration and a clear call-to-action                | PO + Designer   |
+| AC-UI5 | {Platform-specific — e.g., web: "All screens pass WCAG AA contrast check"}    | QA              |
+| AC-UI6 | {Platform-specific — e.g., app: "Back gesture on all screens returns to correct previous screen"} | QA |
+| AC-UI7 | {Feature-specific UI criterion from Business PRD wireframe section}             | PO              |
+
+---
+
+# Appendix
+
+## Figma Summary
+
+| Screen          | Figma Frame                          | Link / Fetch Status                  |
+|-----------------|--------------------------------------|--------------------------------------|
+| {Screen 1}      | [Link]({figma_frames[Screen 1]})     | ✅ Linked & fetched                  |
+| {Screen 2}      | —                                    | ❌ Missing — no node-id link provided |
+
+## Design Tokens Referenced
+
+| Token                 | Value         | Used in                         |
+|-----------------------|---------------|---------------------------------|
+| `color.primary`       | {#hex}        | Primary buttons, links, active states |
+| `color.surface`       | {#hex}        | Card backgrounds                |
+| `spacing.md`          | {16px / 4}    | Standard vertical gap           |
+| `typography.heading2` | {font/size}   | Screen titles                   |
+
+## References
+
+- [{TICKET-ID}]({prd-path}) — Business PRD (source of AC, UC, BR)
+- {[Other Design Spec](./other-ds.md) — if this feature shares screens}
+
+## AI Assumptions
+
+> Each assumption below was made because PO input was incomplete.
+> PO must review and confirm before sign-off.
+
+- {Assumption 1 — [AI DRAFT]}
+- {One per ❌ Missing screen: "No readable Figma frame for {screen} — text-only draft; blocks sign-off until a node-id link is added."}
+
+---
+
+## Changelog
+
+| Version | Date         | Changes         |
+|---------|--------------|-----------------|
+| 1.0     | {YYYY-MM-DD} | Initial version |
+
+<!--
+  NEXT STEPS:
+  1. Fill any ❌ Missing Figma frame links (node-id links) — re-run to fetch & ground them.
+  2. Share with Designer — verify Figma links, update component inventory.
+  3. PO + Designer sign off: change Status → "approved" (only allowed when 0 screens are ❌ Missing).
+  4. Run /generate-bdd "{prd-file}" — BDD uses AC-UI from this spec for FE scenarios.
+-->
+````
+
+---
+
+## Quality Checklist *(verify before writing)*
+
+- [ ] Every screen in Screen Inventory has a complete Screen Spec in Section 2
+- [ ] Every screen has at minimum: default, loading, error states defined
+- [ ] All Figma components mapped in Component Inventory — unmapped flagged as `[NEW]` or `[TODO]`
+- [ ] Only the platform-relevant section generated in Section 3 (no web section in app docs, and vice versa)
+- [ ] Only the platform-relevant section generated in Section 4
+- [ ] AC-UI items are testable (clear pass/fail, not "looks good")
+- [ ] Business PRD cross-reference link is valid relative path
+- [ ] Every screen has a node-level Figma frame link (`?node-id=`) — and screens with a link were fetched via Figma MCP and used to ground the spec
+- [ ] Each ❌ Missing screen is flagged in-spec (`> [DRAFT — no Figma frame...]`), listed in Figma Summary, and has an AI Assumption
+- [ ] If any screen is ❌ Missing → Status stays `draft` and the Output below blocks `/generate-bdd`
+
+---
+
+## Output
+
+{{include:steps/report-footer.md}}
+
+{If missing_frames is empty}:
+```
+/generate-design-spec Complete — {TICKET-ID} [{active_platform}]
+---
+Status : ✅ Complete — all {N} screens linked & fetched from Figma
+Output Artifacts:
+  created {paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md  (v1.0)
+Next   : Share with Designer → PO + Designer sign-off (Status: approved)
+         → /generate-bdd {prd-file}  (generates BDD per service; reads AC-UI from Design Spec)
+```
+
+{If missing_frames is non-empty}:
+```
+/generate-design-spec Complete (DRAFT) — {TICKET-ID} [{active_platform}]
+---
+Status : ⚠️ Warnings — {count} screen(s) without a readable Figma frame: {comma-separated missing_frames}
+Output Artifacts:
+  created {paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md  (v1.0, draft)
+Next   : 🔒 Sign-off & /generate-bdd are BLOCKED until every screen has a node-id Figma link.
+         1. In Figma: select each missing frame → right-click → Copy link to selection
+         2. Re-run /generate-design-spec {prd-file} → AI fetches & grounds the new frames
+```