mirror of
https://github.com/nexu-io/open-design.git
synced 2026-06-01 03:14:35 +07:00
feat(craft): state-coverage module + opt-ins on dashboard, mobile-app, kanban-board (#502)
* feat(craft): add state-coverage rules + opt-ins on dashboard, mobile-app, kanban-board
State coverage is the most reliable AI-design failure: agents ship only the
populated state. This adds craft/state-coverage.md (108 lines, matches the
existing craft format) covering the five required states (loading, empty,
error, populated, edge), three form-specific states, ARIA/focus rules, and
loading-duration thresholds.
Sources are public: WCAG 2.2, NN/g, Material Design 3, Apple HIG, Baymard.
Three skills with stateful UI opt in via od.craft.requires:
- dashboard
- mobile-app
- kanban-board
Decks, ppt, image-poster and other static-output skills do not opt in.
Refs: see issue body for the broader proposal (state-coverage is module 1
of 5 behavioral craft modules).
* fix(craft): address review findings on state-coverage
Four P2 findings from #502 review addressed in one pass.
- Edge state Test matrix added under the five-states table (dashboard,
mobile, form, search, detail-view scenarios with concrete thresholds).
- Server-driven empty pattern added as trailing note in the empty-state
composition section.
- Retry discipline subsection added after error severity tiers
(immediate first retry, exponential 2s/4s/8s backoff, 3-retry floor,
Last-attempted timestamp).
- README enforcement-levels subsection added distinguishing auto-checked
P0 rules from guidance; partial-stateful skill clarification added
after the Files table.
No rewrites. ~30 lines added. File stays inside the 80-110-line craft
target.
* fix(craft): correct lint enforcement claim + remove duplicate threshold message
Two findings from @mrcfps review (Looper-generated against ee95b909).
- README: rewrote Enforcement-levels P0 description. Verified against
apps/daemon/src/server.ts:1706-1727: /api/artifacts/save writes the
file first, then calls lintArtifact, then returns findings in the
response. Findings reach the UI (P0/P1 badges) and the agent (system
reminder for self-correction). Persistence is not hard-blocked on P0.
Original wording mischaracterized this as a generation gate.
- state-coverage: 30-60s duration-table bucket no longer duplicates the
'15 s taking longer than expected' message from the loading row.
Reworded to focus on cancel affordance and explicitly note the
longer-than-expected notice already fired at 15 s.
Both findings non-blocking per Looper but genuine factual issues. Fixed
in one pass.
This commit is contained in:
parent
76e6c7a9f6
commit
ab58b62b17
5 changed files with 152 additions and 0 deletions
|
|
@ -42,6 +42,15 @@ a follow-up PR, with no skill edit needed. The cost of a missed
|
|||
reference is a missing paragraph in the system prompt, not a broken
|
||||
skill — so the loud failure mode is not worth the friction.
|
||||
|
||||
### Enforcement levels
|
||||
|
||||
Craft files mix auto-checked rules and guidance.
|
||||
|
||||
- **Auto-checked.** Rules wired into `apps/daemon/src/lint-artifact.ts` — currently the P0 list in `anti-ai-slop.md` (Tailwind-indigo accent, two-stop hero gradients, emoji-as-icons, etc.). The linter reports these as findings back to the UI (for P0/P1 badges) and to the agent (as a system reminder for self-correction). Artifact persistence is not currently hard-blocked on P0 hits.
|
||||
- **Guidance.** The rest. The agent reads the rules, reviewers apply them, the linter doesn't check them.
|
||||
|
||||
A purely behavioral craft file (state-coverage, animation-discipline) is guidance unless a specific rule is later promoted into `lint-artifact.ts`.
|
||||
|
||||
## Files
|
||||
|
||||
| File | Section name | When to require |
|
||||
|
|
@ -49,6 +58,9 @@ skill — so the loud failure mode is not worth the friction.
|
|||
| `typography.md` | `typography` | Any skill that emits typed content (~all skills) |
|
||||
| `color.md` | `color` | Any skill that emits styled output (~all skills) |
|
||||
| `anti-ai-slop.md` | `anti-ai-slop` | Marketing pages, landing pages, decks |
|
||||
| `state-coverage.md` | `state-coverage` | Any skill with stateful UI (dashboards, mobile apps, forms, list/table views) |
|
||||
|
||||
**Partial-stateful skills.** A skill that's mostly static but contains an embedded form, data table, or query surface should opt in. State-coverage rules apply to the stateful component, not the whole page.
|
||||
|
||||
More sections (`motion`, `icons`, `craft-details`) will be added in
|
||||
follow-up PRs as we wire the linter side.
|
||||
|
|
|
|||
134
craft/state-coverage.md
Normal file
134
craft/state-coverage.md
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
# State coverage craft rules
|
||||
|
||||
Universal rules for what every interactive surface must render. The active
|
||||
`DESIGN.md` decides how each state looks; this file decides which states must
|
||||
exist and what they must contain. The single most reliable AI-design failure
|
||||
is shipping only the populated state.
|
||||
|
||||
> Distilled from WCAG 2.2, NN/g, Material Design 3, Apple HIG, and Baymard
|
||||
> Institute checkout research.
|
||||
|
||||
## The five required states
|
||||
|
||||
Every surface that fetches, transforms, or accepts data must render all five.
|
||||
|
||||
| State | Triggered when | Must contain |
|
||||
|---|---|---|
|
||||
| **Loading** | Data is in flight | Skeleton, spinner, or shell — plus a 15 s "taking longer than expected" fallback |
|
||||
| **Empty** | No records yet, or query returned nothing | Headline, plain explanation, primary CTA |
|
||||
| **Error** | Fetch failed, server failure, validation rejection | Plain-language cause, recovery action, preserved user input |
|
||||
| **Populated** | Data present, primary case | The state the design was actually drawn for |
|
||||
| **Edge** | Extreme volume, long strings, missing optional fields, RTL or long-word content, partial network | Layout that does not break |
|
||||
|
||||
Render-and-screenshot test: every list, table, card, form, and panel in the
|
||||
artifact has all five. Missing states are the most common silent failure of
|
||||
AI-generated UI.
|
||||
|
||||
**Test matrix.** Concrete edge scenarios the surface must survive:
|
||||
|
||||
| Skill type | Edge scenario |
|
||||
|---|---|
|
||||
| Dashboard / table | 10,000+ rows, all numeric columns, sort + filter applied |
|
||||
| Mobile card / list | 200-char title, missing avatar, missing secondary CTA |
|
||||
| Form | All optional fields empty, all required fields at max length |
|
||||
| Search results | Single-character query, query with only special chars, 1,000+ result count |
|
||||
| Detail view | Missing all optional metadata, RTL primary content with LTR embeds |
|
||||
|
||||
## Form-specific states
|
||||
|
||||
Forms add three states on top of the five.
|
||||
|
||||
| State | Triggered when | Behavior |
|
||||
|---|---|---|
|
||||
| **Untouched** | Field has not yet had focus | Default styling; no validation messages |
|
||||
| **Dirty (valid)** | User typed and field passes validation | Persistent helper text remains; no success-coloring |
|
||||
| **Submitted-pending** | Submit clicked, awaiting server | Submit button enters loading state; fields lock against re-submission |
|
||||
|
||||
Validation timing: validate **on blur**, not on first keystroke. For password
|
||||
and similar live fields, validate on each keystroke *only after the first
|
||||
blur*. Remove the error message the instant input becomes valid.
|
||||
|
||||
## Empty state composition
|
||||
|
||||
Empty is not the absence of state. It is its own state with a job.
|
||||
|
||||
- **First-use empty** — illustration + headline + value sentence + primary CTA. The empty is the onboarding moment.
|
||||
- **No-results empty** — echo the query, suggest alternatives, never leave a true blank.
|
||||
- **Cleared empty** — celebratory phrasing, optional next-action.
|
||||
- **Error-as-empty** — never. An error is its own state with recovery information; do not collapse error into empty.
|
||||
|
||||
**Server-driven vs client-driven.** When a search or query API can return fallback content in the empty payload (suggestions, related categories, popular results), prefer that over a client-side echo. Algolia, Elastic, and most modern search backends support this — the server has more context for what "no results, but maybe try X" should mean.
|
||||
|
||||
## Error state composition
|
||||
|
||||
Every error must answer three questions, in this order:
|
||||
|
||||
1. **What happened.** "Your card was declined." Not "Something went wrong."
|
||||
2. **Why, if knowable.** "Insufficient funds." Or "Network unreachable — check your connection."
|
||||
3. **What the user can do.** A retry button, an alternative path, or a support link.
|
||||
|
||||
Preserve user input across the error. The form must not clear on submit
|
||||
failure.
|
||||
|
||||
Severity tiers:
|
||||
|
||||
- **Field-level** — red border, inline message, focus moves to the field.
|
||||
- **Form-level** — error summary banner at top + per-field markers.
|
||||
- **Section-level** — inline panel with retry, surrounding sections still functional.
|
||||
- **Page-level** — full error state with illustration and recovery CTA.
|
||||
- **App-level** — persistent banner or modal for critical loss-of-functionality.
|
||||
|
||||
Match severity to surface scope. A field validation failure does not warrant
|
||||
a page-level error.
|
||||
|
||||
**Retry discipline.** A retry surface is not a button alone. It has timing rules:
|
||||
|
||||
- First retry fires immediately on user click.
|
||||
- Second and third retries use exponential backoff: 2 s, 4 s, 8 s max.
|
||||
- After 3 failed retries, replace "Retry" with "Contact support" plus a copyable error ID. The user has done their job; the system now needs a human.
|
||||
- Show "Last attempted: Xs ago" on the error surface after the first retry, so the user knows how stale the failure is.
|
||||
|
||||
## Loading state thresholds
|
||||
|
||||
Pick the indicator by expected duration, not by what's available in the
|
||||
component library.
|
||||
|
||||
| Duration | Indicator |
|
||||
|---|---|
|
||||
| 0–300 ms | None. Render synchronously; users perceive no delay. |
|
||||
| 300 ms – 2 s | Subtle spinner or skeleton. |
|
||||
| 2 – 10 s | Skeleton matched to expected layout, or labelled spinner ("Loading payments…"). |
|
||||
| 10 – 30 s | Determinate progress bar with cancel option. |
|
||||
| 30 – 60 s | Progress bar with explicit cancel affordance. The "taking longer than expected" notice already appeared at 15 s; do not repeat it. |
|
||||
| 60 s+ | Stop animation. Show error with retry, cancel, or continue. |
|
||||
|
||||
Never leave a spinner running indefinitely. Start a timeout on every request.
|
||||
|
||||
## ARIA and focus rules
|
||||
|
||||
State changes must be announced and focused correctly.
|
||||
|
||||
| Change | ARIA | Focus action |
|
||||
|---|---|---|
|
||||
| Inline error on submit | `role="alert"` on the message | Move focus to first error field |
|
||||
| Toast / non-urgent confirmation | `role="status"` (polite live region) | Do not move focus |
|
||||
| Critical error or destructive confirmation | `role="alertdialog"` (assertive) | Move focus to dialog |
|
||||
| Loading begins | `role="status"` announcement ("Loading…") | Do not move focus to spinner |
|
||||
| Loading ends, content appears | — | Move focus to loaded content if action was user-initiated |
|
||||
|
||||
Live region containers must exist in the DOM before content is injected.
|
||||
Adding `aria-live` simultaneously with content does not trigger an
|
||||
announcement.
|
||||
|
||||
## Common mistakes (lint these)
|
||||
|
||||
- Surface renders only the populated state; loading, empty, error, and edge are absent.
|
||||
- Empty state is a literal blank or "No data" text with no headline, explanation, or action.
|
||||
- Error message reads "Something went wrong" with no cause or recovery.
|
||||
- Spinner with no timeout; runs indefinitely on slow or failed requests.
|
||||
- Submit clears form fields on validation failure, forcing re-entry.
|
||||
- Inline validation fires on first keystroke instead of on blur.
|
||||
- Full-page loading replaces the chrome when only one section is fetching.
|
||||
- Toast appears at a different screen position than previous toasts in the same artifact.
|
||||
- Color alone conveys error state — no icon, no text label.
|
||||
- Auto-dismissing toast cannot be paused on hover or focus (WCAG SC 2.2.1).
|
||||
|
|
@ -22,6 +22,8 @@ od:
|
|||
design_system:
|
||||
requires: true
|
||||
sections: [color, typography, layout, components]
|
||||
craft:
|
||||
requires: [state-coverage]
|
||||
---
|
||||
|
||||
# Dashboard Skill
|
||||
|
|
|
|||
|
|
@ -22,6 +22,8 @@ od:
|
|||
design_system:
|
||||
requires: true
|
||||
sections: [color, typography, layout, components]
|
||||
craft:
|
||||
requires: [state-coverage]
|
||||
example_prompt: "Make me a kanban board for a 5-person growth squad mid-sprint — backlog, doing, review, done."
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -24,6 +24,8 @@ od:
|
|||
design_system:
|
||||
requires: true
|
||||
sections: [color, typography, layout, components]
|
||||
craft:
|
||||
requires: [state-coverage]
|
||||
---
|
||||
|
||||
# Mobile App Skill
|
||||
|
|
|
|||
Loading…
Reference in a new issue