super-ux 0.7.0 → 0.8.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/CHANGELOG.md +24 -0
- package/README.md +4 -2
- package/cursor/rules/ux-flows.mdc +47 -0
- package/package.json +1 -1
- package/templates/flows.md +29 -0
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,30 @@ All notable changes to this project are documented in this file. The format
|
|
|
4
4
|
follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions
|
|
5
5
|
follow [SemVer](https://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
|
+
## [0.8.0] - 2026-07-23
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- **ux-flows skill** — the HOW layer (`docs/ux/flows.md`): task analysis →
|
|
12
|
+
mermaid user flows (screens, explicit branches, recoverable error edges,
|
|
13
|
+
all entry points) → screen/state tables → optional ASCII wireframes and
|
|
14
|
+
storyboards. Workflows: Design (forward), Reverse (backwards mode for
|
|
15
|
+
existing products, `inferred` tags with file:line evidence), Update,
|
|
16
|
+
Improve (heuristic evaluation → traced before/after redesign proposals).
|
|
17
|
+
- **ux-design-principles.md** — the agent's thinking playbook: the 7-step
|
|
18
|
+
pipeline (research → define → structure → specify → visualize → build →
|
|
19
|
+
verify) with forward and backwards modes, task-analysis method, flow and
|
|
20
|
+
screen rules, heuristics PRN-01..10 (after Nielsen) and cognitive
|
|
21
|
+
principles PRN-11..16 with audit questions, the improvement procedure,
|
|
22
|
+
wireframe/storyboard conventions, anti-patterns.
|
|
23
|
+
- **ux-contract v3** — scenarios become use cases: steps as `user action ->
|
|
24
|
+
system response`, new `Alt paths` field, `Traces` includes `FLW-NN`;
|
|
25
|
+
traceability now covers flows (every node and edge needs a scenario).
|
|
26
|
+
- `ux-audit`: verifies code against flow diagrams (nodes reachable, edges
|
|
27
|
+
wired, states present); new `heuristics` scope (`[PRN-NN]` findings).
|
|
28
|
+
- `/ux-flows` command; `/ux` menu grows to 11 actions including "Improve
|
|
29
|
+
existing UX"; `/ux-init` now chains foundation → flows → scenarios.
|
|
30
|
+
|
|
7
31
|
## [0.7.0] - 2026-07-20
|
|
8
32
|
|
|
9
33
|
### Added
|
package/README.md
CHANGED
|
@@ -33,10 +33,12 @@ flowchart LR
|
|
|
33
33
|
| Piece | Purpose |
|
|
34
34
|
|---|---|
|
|
35
35
|
| skill `ux-foundation` | The WHY layer (`docs/ux/foundation.md`): personas, Jobs to Be Done with forces, customer journey maps, user stories with Given/When/Then acceptance criteria |
|
|
36
|
-
| skill `ux-
|
|
36
|
+
| skill `ux-flows` | The HOW layer (`docs/ux/flows.md`): task analysis, mermaid user flows (branches, error recovery, entry points), screen states, optional wireframes; heuristic UX evaluation and traced redesign proposals for existing products |
|
|
37
|
+
| skill `ux-scenarios` | Maintain `docs/ux/scenarios.md`: use-case scenarios (action → system response, alt paths) covering every flow node/edge, `Traces:` to stories and flows, validated for conflicts, coverage, and traceability |
|
|
37
38
|
| skill `ux-audit` | Batched audit loop with full context: code vs every scenario + its story's acceptance criteria; verdicts PASS/PARTIAL/FAIL/BLOCKED with `file:line` evidence; `coverage` scope audits the chain itself |
|
|
38
39
|
| `/ux` | **The one command**: sets up whatever is missing, then status across all layers + a menu of applicable actions with one recommended default. Idempotent |
|
|
39
|
-
| `/ux-foundation` `/ux-init` `/ux-update` `/ux-audit` `/ux-rule` | Direct controls; `/ux-rule` installs the hard rule into the project's CLAUDE.md |
|
|
40
|
+
| `/ux-foundation` `/ux-flows` `/ux-init` `/ux-update` `/ux-audit` `/ux-rule` | Direct controls; `/ux-rule` installs the hard rule into the project's CLAUDE.md |
|
|
41
|
+
| [ux-design-principles.md](plugins/super-ux/skills/references/ux-design-principles.md) | How the agent thinks: the design pipeline (forward + backwards), task analysis, flow rules, heuristics PRN-01..16, improvement procedure, anti-patterns |
|
|
40
42
|
| `cursor/rules/*.mdc` | The same methodology for Cursor (always-on hard rule + three agent-requested rules) |
|
|
41
43
|
| `templates/` | Skeletons for the foundation, scenario base, audit report, and the CLAUDE.md rule snippet |
|
|
42
44
|
| [best-practices.md](plugins/super-ux/skills/references/best-practices.md) | Living, tag-indexed catalog of proven UX/growth practices (seeded with 48 subscription-app laws); agents filter by stage/domain tags and apply what serves a traced job |
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Design or improve user flows (docs/ux/flows.md): apply for task analysis, flow diagrams, screen states, wireframes, heuristic UX evaluation, or any 'improve/fix the UX' request"
|
|
3
|
+
alwaysApply: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# ux-flows — Design HOW Users Move
|
|
7
|
+
|
|
8
|
+
`docs/ux/flows.md` is the HOW layer between foundation (stories) and
|
|
9
|
+
scenarios: task analysis + mermaid user flows + screen states. IDs
|
|
10
|
+
`FLW-NN`, sequential, never reused; superseded flows kept with a note.
|
|
11
|
+
|
|
12
|
+
## Flow entry (ux-contract v3)
|
|
13
|
+
|
|
14
|
+
Fields: `Traces` (story/job IDs), `Goal` (observable end state), `Entry
|
|
15
|
+
points` (ALL of them), `Success exit`, `Task analysis` (numbered
|
|
16
|
+
user-visible micro-steps), mermaid `flowchart` (screens as
|
|
17
|
+
`Screen: <name>`, decisions as diamonds, `*_err` error nodes with labeled
|
|
18
|
+
recovery edges), `Screens & states` table (each screen:
|
|
19
|
+
loading/empty/error/success + key elements, one primary action).
|
|
20
|
+
|
|
21
|
+
## Design rules
|
|
22
|
+
|
|
23
|
+
- One flow = one user goal. Task analysis first: cut/merge/default-away
|
|
24
|
+
every step that doesn't serve the job; pull first value as early as
|
|
25
|
+
possible; happy path ≤5 steps or justified.
|
|
26
|
+
- Every decision an explicit branch; every error edge lands on recovery —
|
|
27
|
+
dead ends are defects; all entry points enumerated.
|
|
28
|
+
- Wireframes optional (`docs/ux/wireframes/FLW-NN.md`, ASCII hierarchy +
|
|
29
|
+
primary action, not pixels); storyboard only when usage context drives
|
|
30
|
+
design.
|
|
31
|
+
- Backwards mode (existing product): reconstruct flows as they ARE from
|
|
32
|
+
code with file:line evidence, tag `inferred` until confirmed; gaps
|
|
33
|
+
between is/should become the improvement backlog.
|
|
34
|
+
|
|
35
|
+
## Improving existing UX
|
|
36
|
+
|
|
37
|
+
Walk flows against heuristics: system status visible; user's words not
|
|
38
|
+
jargon; undo/cancel/back everywhere; consistency; error prevention over
|
|
39
|
+
error messages; recognition over recall; shortcuts for frequent users;
|
|
40
|
+
minimalist screens; recovery-oriented error text; help in context;
|
|
41
|
+
progressive disclosure; smart defaults; limited choices; familiar
|
|
42
|
+
patterns; prominent primary targets; polished peaks and endings.
|
|
43
|
+
|
|
44
|
+
Violations: `[PRN-NN] node — issue — severity`. Redesign proposals MUST
|
|
45
|
+
trace to a pain/job/story, cite the principle/practice, show flow
|
|
46
|
+
before → after, and state the expected observable effect. Prioritize
|
|
47
|
+
Frequency × Severity × Solvability. Cascade approved changes to scenarios.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "super-ux",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "Scenario-driven UI development for AI agents (Claude Code + Cursor): scenario base, scenario-first hard rule, evidence-backed UX audits. This package is the installer CLI.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"super-ux": "bin/super-ux.js"
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# User Flows
|
|
2
|
+
|
|
3
|
+
<!-- Managed with super-ux (ux-contract v3). The HOW layer: task analysis
|
|
4
|
+
and user flows. Scenarios in scenarios.md trace to FLW-IDs and must cover
|
|
5
|
+
every node and edge. -->
|
|
6
|
+
|
|
7
|
+
<!-- ### FLW-01: <user goal>
|
|
8
|
+
- **Traces:** ST-001 (JTBD-01, JRN-01/#2)
|
|
9
|
+
- **Goal:** <observable end state for the user>
|
|
10
|
+
- **Entry points:** <all of them: screen, deep link, push, empty-state CTA>
|
|
11
|
+
- **Success exit:** <where the user lands on success>
|
|
12
|
+
- **Task analysis:**
|
|
13
|
+
1. <user-visible micro-step; cut everything that doesn't serve the job>
|
|
14
|
+
- **Flow:**
|
|
15
|
+
|
|
16
|
+
```mermaid
|
|
17
|
+
flowchart TD
|
|
18
|
+
A[Screen: <name>] -->|<action>| B{<decision?>}
|
|
19
|
+
B -->|ok| C[Screen: <next>]
|
|
20
|
+
B -->|fail| B_err[<error + recovery>]
|
|
21
|
+
B_err --> A
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
- **Screens & states:**
|
|
25
|
+
| Screen | States | Key elements |
|
|
26
|
+
|--------|--------|--------------|
|
|
27
|
+
| <name> | loading, empty, error, success | <elements, one primary action> |
|
|
28
|
+
- **Wireframe:** wireframes/FLW-01.md (optional)
|
|
29
|
+
-->
|