mirror of https://github.com/garrytan/gstack.git
224 lines
14 KiB
Cheetah
224 lines
14 KiB
Cheetah
## Review Sections (7 passes, after scope is agreed)
|
|
|
|
**Anti-skip rule:** Never condense, abbreviate, or skip any review pass (1-7) regardless of plan type (strategy, spec, code, infra). Every pass in this skill exists for a reason. "This is a strategy doc so design passes don't apply" is always wrong — design gaps are where implementation breaks down. If a pass genuinely has zero findings, say "No issues found" and move on — but you must evaluate it.
|
|
|
|
{{ANTI_SHORTCUT_CLAUSE}}
|
|
|
|
{{LEARNINGS_SEARCH}}
|
|
|
|
### Pass 1: Information Architecture
|
|
Rate 0-10: Does the plan define what the user sees first, second, third?
|
|
FIX TO 10: Add information hierarchy to the plan. Include ASCII diagram of screen/page structure and navigation flow. Apply "constraint worship" — if you can only show 3 things, which 3?
|
|
**STOP.** AskUserQuestion once per issue. Do NOT batch. Recommend + WHY. If no issues, say so and move on. Do NOT proceed until user responds.
|
|
|
|
### Pass 2: Interaction State Coverage
|
|
Rate 0-10: Does the plan specify loading, empty, error, success, partial states?
|
|
FIX TO 10: Add interaction state table to the plan:
|
|
```
|
|
FEATURE | LOADING | EMPTY | ERROR | SUCCESS | PARTIAL
|
|
---------------------|---------|-------|-------|---------|--------
|
|
[each UI feature] | [spec] | [spec]| [spec]| [spec] | [spec]
|
|
```
|
|
For each state: describe what the user SEES, not backend behavior.
|
|
Empty states are features — specify warmth, primary action, context.
|
|
**STOP.** AskUserQuestion once per issue. Do NOT batch. Recommend + WHY.
|
|
|
|
### Pass 3: User Journey & Emotional Arc
|
|
Rate 0-10: Does the plan consider the user's emotional experience?
|
|
FIX TO 10: Add user journey storyboard:
|
|
```
|
|
STEP | USER DOES | USER FEELS | PLAN SPECIFIES?
|
|
-----|------------------|-----------------|----------------
|
|
1 | Lands on page | [what emotion?] | [what supports it?]
|
|
...
|
|
```
|
|
Apply time-horizon design: 5-sec visceral, 5-min behavioral, 5-year reflective.
|
|
**STOP.** AskUserQuestion once per issue. Do NOT batch. Recommend + WHY.
|
|
|
|
### Pass 4: AI Slop Risk
|
|
Rate 0-10: Does the plan describe specific, intentional UI — or generic patterns?
|
|
FIX TO 10: Rewrite vague UI descriptions with specific alternatives.
|
|
|
|
{{DESIGN_HARD_RULES}}
|
|
- "Cards with icons" → what differentiates these from every SaaS template?
|
|
- "Hero section" → what makes this hero feel like THIS product?
|
|
- "Clean, modern UI" → meaningless. Replace with actual design decisions.
|
|
- "Dashboard with widgets" → what makes this NOT every other dashboard?
|
|
If visual mockups were generated in Step 0.5, evaluate them against the AI slop blacklist above. Read each mockup image using the Read tool. Does the mockup fall into generic patterns (3-column grid, centered hero, stock-photo feel)? If so, flag it and offer to regenerate with more specific direction via `$D iterate --feedback "..."`.
|
|
**STOP.** AskUserQuestion once per issue. Do NOT batch. Recommend + WHY.
|
|
|
|
### Pass 5: Design System Alignment
|
|
Rate 0-10: Does the plan align with DESIGN.md?
|
|
FIX TO 10: If DESIGN.md exists, annotate with specific tokens/components. If no DESIGN.md, flag the gap and recommend `/design-consultation`.
|
|
Flag any new component — does it fit the existing vocabulary?
|
|
**STOP.** AskUserQuestion once per issue. Do NOT batch. Recommend + WHY.
|
|
|
|
### Pass 6: Responsive & Accessibility
|
|
Rate 0-10: Does the plan specify mobile/tablet, keyboard nav, screen readers?
|
|
FIX TO 10: Add responsive specs per viewport — not "stacked on mobile" but intentional layout changes. Add a11y: keyboard nav patterns, ARIA landmarks, touch target sizes (44px min), color contrast requirements.
|
|
**STOP.** AskUserQuestion once per issue. Do NOT batch. Recommend + WHY.
|
|
|
|
### Pass 7: Unresolved Design Decisions
|
|
Surface ambiguities that will haunt implementation:
|
|
```
|
|
DECISION NEEDED | IF DEFERRED, WHAT HAPPENS
|
|
-----------------------------|---------------------------
|
|
What does empty state look like? | Engineer ships "No items found."
|
|
Mobile nav pattern? | Desktop nav hides behind hamburger
|
|
...
|
|
```
|
|
If visual mockups were generated in Step 0.5, reference them as evidence when surfacing unresolved decisions. A mockup makes decisions concrete — e.g., "Your approved mockup shows a sidebar nav, but the plan doesn't specify mobile behavior. What happens to this sidebar on 375px?"
|
|
Each decision = one AskUserQuestion with recommendation + WHY + alternatives. Edit the plan with each decision as it's made.
|
|
|
|
### Post-Pass: Update Mockups (if generated)
|
|
|
|
If mockups were generated in Step 0.5 and review passes changed significant design decisions (information architecture restructure, new states, layout changes), offer to regenerate (one-shot, not a loop):
|
|
|
|
AskUserQuestion: "The review passes changed [list major design changes]. Want me to regenerate mockups to reflect the updated plan? This ensures the visual reference matches what we're actually building."
|
|
|
|
If yes, use `$D iterate` with feedback summarizing the changes, or `$D variants` with an updated brief. Save to the same `$_DESIGN_DIR` directory.
|
|
|
|
## CRITICAL RULE — How to ask questions
|
|
Follow the AskUserQuestion format from the Preamble above. Additional rules for plan design reviews:
|
|
* **One issue = one AskUserQuestion call.** Never combine multiple issues into one question.
|
|
* Describe the design gap concretely — what's missing, what the user will experience if it's not specified.
|
|
* Present 2-3 options. For each: effort to specify now, risk if deferred.
|
|
* **Map to Design Principles above.** One sentence connecting your recommendation to a specific principle.
|
|
* Label with issue NUMBER + option LETTER (e.g., "3A", "3B").
|
|
* **Zero findings:** if a section has zero findings, state "No issues, moving on" and proceed. Otherwise, use AskUserQuestion for each gap — a gap with an "obvious fix" is still a gap and still needs user approval before any change lands in the plan.
|
|
* **NEVER use AskUserQuestion to ask which variant the user prefers.** Always create a comparison board first (`$D compare --serve`) and open it in the browser. The board has rating controls, comments, remix/regenerate buttons, and structured feedback output. Use AskUserQuestion ONLY to notify the user the board is open and wait for them to finish — not to present variants inline and ask "which do you prefer?" That is a degraded experience.
|
|
|
|
## Required Outputs
|
|
|
|
### "NOT in scope" section
|
|
Design decisions considered and explicitly deferred, with one-line rationale each.
|
|
|
|
### "What already exists" section
|
|
Existing DESIGN.md, UI patterns, and components that the plan should reuse.
|
|
|
|
### TODOS.md updates
|
|
After all review passes are complete, present each potential TODO as its own individual AskUserQuestion. Never batch TODOs — one per question. Never silently skip this step.
|
|
|
|
For design debt: missing a11y, unresolved responsive behavior, deferred empty states. Each TODO gets:
|
|
* **What:** One-line description of the work.
|
|
* **Why:** The concrete problem it solves or value it unlocks.
|
|
* **Pros:** What you gain by doing this work.
|
|
* **Cons:** Cost, complexity, or risks of doing it.
|
|
* **Context:** Enough detail that someone picking this up in 3 months understands the motivation.
|
|
* **Depends on / blocked by:** Any prerequisites.
|
|
|
|
Then present options: **A)** Add to TODOS.md **B)** Skip — not valuable enough **C)** Build it now in this PR instead of deferring.
|
|
|
|
{{TASKS_SECTION_EMIT:design-review}}
|
|
|
|
### Completion Summary
|
|
```
|
|
+====================================================================+
|
|
| DESIGN PLAN REVIEW — COMPLETION SUMMARY |
|
|
+====================================================================+
|
|
| System Audit | [DESIGN.md status, UI scope] |
|
|
| Step 0 | [initial rating, focus areas] |
|
|
| Pass 1 (Info Arch) | ___/10 → ___/10 after fixes |
|
|
| Pass 2 (States) | ___/10 → ___/10 after fixes |
|
|
| Pass 3 (Journey) | ___/10 → ___/10 after fixes |
|
|
| Pass 4 (AI Slop) | ___/10 → ___/10 after fixes |
|
|
| Pass 5 (Design Sys) | ___/10 → ___/10 after fixes |
|
|
| Pass 6 (Responsive) | ___/10 → ___/10 after fixes |
|
|
| Pass 7 (Decisions) | ___ resolved, ___ deferred |
|
|
+--------------------------------------------------------------------+
|
|
| NOT in scope | written (___ items) |
|
|
| What already exists | written |
|
|
| TODOS.md updates | ___ items proposed |
|
|
| Approved Mockups | ___ generated, ___ approved |
|
|
| Decisions made | ___ added to plan |
|
|
| Decisions deferred | ___ (listed below) |
|
|
| Overall design score | ___/10 → ___/10 |
|
|
+====================================================================+
|
|
```
|
|
|
|
If all passes 8+: "Plan is design-complete. Run /design-review after implementation for visual QA."
|
|
If any below 8: note what's unresolved and why (user chose to defer).
|
|
|
|
### Unresolved Decisions
|
|
If any AskUserQuestion goes unanswered, note it here. Never silently default to an option.
|
|
|
|
### Approved Mockups
|
|
|
|
If visual mockups were generated during this review, add to the plan file:
|
|
|
|
```
|
|
## Approved Mockups
|
|
|
|
| Screen/Section | Mockup Path | Direction | Notes |
|
|
|----------------|-------------|-----------|-------|
|
|
| [screen name] | ~/.gstack/projects/$SLUG/designs/[folder]/[filename].png | [brief description] | [constraints from review] |
|
|
```
|
|
|
|
Include the full path to each approved mockup (the variant the user chose), a one-line description of the direction, and any constraints. The implementer reads this to know exactly which visual to build from. These persist across conversations and workspaces. If no mockups were generated, omit this section.
|
|
|
|
## Review Log
|
|
|
|
After producing the Completion Summary above, persist the review result.
|
|
|
|
**PLAN MODE EXCEPTION — ALWAYS RUN:** This command writes review metadata to
|
|
`~/.gstack/` (user config directory, not project files). The skill preamble
|
|
already writes to `~/.gstack/sessions/` and `~/.gstack/analytics/` — this is
|
|
the same pattern. The review dashboard depends on this data. Skipping this
|
|
command breaks the review readiness dashboard in /ship.
|
|
|
|
```bash
|
|
~/.claude/skills/gstack/bin/gstack-review-log '{"skill":"plan-design-review","timestamp":"TIMESTAMP","status":"STATUS","initial_score":N,"overall_score":N,"unresolved":N,"decisions_made":N,"commit":"COMMIT"}'
|
|
```
|
|
|
|
Substitute values from the Completion Summary:
|
|
- **TIMESTAMP**: current ISO 8601 datetime
|
|
- **STATUS**: "clean" if overall score 8+ AND 0 unresolved; otherwise "issues_open"
|
|
- **initial_score**: initial overall design score before fixes (0-10)
|
|
- **overall_score**: final overall design score after fixes (0-10)
|
|
- **unresolved**: number of unresolved design decisions
|
|
- **decisions_made**: number of design decisions added to the plan
|
|
- **COMMIT**: output of `git rev-parse --short HEAD`
|
|
|
|
{{REVIEW_DASHBOARD}}
|
|
|
|
{{PLAN_FILE_REVIEW_REPORT}}
|
|
|
|
{{LEARNINGS_LOG}}
|
|
|
|
{{GBRAIN_SAVE_RESULTS}}
|
|
|
|
{{BRAIN_WRITE_BACK}}
|
|
|
|
{{BRAIN_CACHE_REFRESH}}
|
|
|
|
## Next Steps — Review Chaining
|
|
|
|
After displaying the Review Readiness Dashboard, recommend the next review(s) based on what this design review discovered. Read the dashboard output to see which reviews have already been run and whether they are stale.
|
|
|
|
**Recommend /plan-eng-review if eng review is not skipped globally** — check the dashboard output for `skip_eng_review`. If it is `true`, eng review is opted out — do not recommend it. Otherwise, eng review is the required shipping gate. If this design review added significant interaction specifications, new user flows, or changed the information architecture, emphasize that eng review needs to validate the architectural implications. If an eng review already exists but the commit hash shows it predates this design review, note that it may be stale and should be re-run.
|
|
|
|
**Consider recommending /plan-ceo-review** — but only if this design review revealed fundamental product direction gaps. Specifically: if the overall design score started below 4/10, if the information architecture had major structural problems, or if the review surfaced questions about whether the right problem is being solved. AND no CEO review exists in the dashboard. This is a selective recommendation — most design reviews should NOT trigger a CEO review.
|
|
|
|
**If both are needed, recommend eng review first** (required gate).
|
|
|
|
**Recommend design exploration skills when appropriate** — /design-shotgun and /design-html
|
|
produce design artifacts (mockups, HTML previews), not application code. They belong in
|
|
plan mode alongside reviews. If this design review found visual issues that would benefit
|
|
from exploring new directions, recommend /design-shotgun. If approved mockups exist and
|
|
need to be turned into working HTML, recommend /design-html.
|
|
|
|
Use AskUserQuestion to present the next step. Include only applicable options:
|
|
- **A)** Run /plan-eng-review next (required gate)
|
|
- **B)** Run /plan-ceo-review (only if fundamental product gaps found)
|
|
- **C)** Run /design-shotgun — explore visual design variants for issues found
|
|
- **D)** Run /design-html — generate Pretext-native HTML from approved mockups
|
|
- **E)** Skip — I'll handle next steps manually
|
|
|
|
## Formatting Rules
|
|
* NUMBER issues (1, 2, 3...) and LETTERS for options (A, B, C...).
|
|
* Label with NUMBER + LETTER (e.g., "3A", "3B").
|
|
* One sentence max per option.
|
|
* After each pass, pause and wait for feedback.
|
|
* Rate before and after each pass for scannability.
|
|
|