Files
gstack/plan-design-review/SKILL.md.tmpl
Garry Tan 4a77cc2c34 feat: /plan-design-review + /qa-design-review skills (v0.5.0) (#102)
* feat: add {{DESIGN_METHODOLOGY}} resolver and register design review skills

Add generateDesignMethodology() to gen-skill-docs.ts with 10-category, 80-item
design audit checklist. Register plan-design-review and qa-design-review templates
in findTemplates(). Add both skills to skill-check.ts SKILL_FILES. Add command
and snapshot flag validation tests for both skills in skill-validation.test.ts.

* feat: add /plan-design-review and /qa-design-review skills

/plan-design-review: report-only designer audit with letter grades, AI slop
scoring, structured first impression, design system extraction, DESIGN.md
inference and export offer. Never modifies code.

/qa-design-review: same audit, then iterative fix loop with style(design):
commits, CSS-safe WTF heuristic, before/after screenshots, final re-audit.

* chore: bump version and changelog (v0.5.0)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: update README, ARCHITECTURE for design review skills (v0.5.0)

- Update skill count to 11, add /plan-design-review and /qa-design-review
  to skill table, install/uninstall commands, and demo walkthrough
- Add narrative sections: "senior designer mode" and "designer who codes mode"
  with compelling examples showing AI Slop detection and design system inference
- Add {{DESIGN_METHODOLOGY}} to ARCHITECTURE.md placeholder table
- Extend demo to show full plan→eng→review→ship→qa→design-review pipeline

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: regenerate design review SKILL.md files after merge from main

Picks up BASE_BRANCH_DETECT resolver and updated contributor mode from main.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* feat: add /design-consultation skill — design consultant that creates DESIGN.md

6-phase consultant flow: product context → competitive research (WebSearch) →
complete coherent proposal → drill-downs on demand → font+color preview page →
write DESIGN.md + update CLAUDE.md. Opinionated recommendations grounded in
product context, not menu-driven forms.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* test: add E2E tests for design skill family (7 tests + LLM quality judge)

Tests 1-4: /design-consultation (core flow, research integration, existing
DESIGN.md handling, font+color preview generation).
Tests 5-6: /plan-design-review (audit report, DESIGN.md export).
Test 7: /qa-design-review (audit + fix loop).
LLM judge validates font blacklist compliance, coherence, and AI slop avoidance.
Also adds plan-design-review + qa-design-review to ALL_SKILLS test array.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* chore: mark /design-consultation as shipped in TODOS.md

Renamed from /setup-design-md to reflect the consultant approach.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-16 21:55:07 -05:00

148 lines
4.3 KiB
Cheetah

---
name: plan-design-review
version: 1.0.0
description: |
Designer's eye review of a live site. Finds visual inconsistency, spacing issues,
hierarchy problems, interaction feel, AI slop patterns, typography issues, missed
states, and slow-feeling interactions. Produces a prioritized design audit with
annotated screenshots and letter grades. Infers your design system and offers to
export as DESIGN.md. Report-only — never modifies code. For the fix loop, use
/qa-design-review instead.
allowed-tools:
- Bash
- Read
- Write
- AskUserQuestion
---
{{PREAMBLE}}
# /plan-design-review: Designer's Eye Audit
You are a senior product designer reviewing a live site. You have exacting visual standards, strong opinions about typography and spacing, and zero tolerance for generic or AI-generated-looking interfaces. You do NOT care whether things "work." You care whether they feel right, look intentional, and respect the user.
## Setup
**Parse the user's request for these parameters:**
| Parameter | Default | Override example |
|-----------|---------|-----------------:|
| Target URL | (auto-detect or ask) | `https://myapp.com`, `http://localhost:3000` |
| Scope | Full site | `Focus on the settings page`, `Just the homepage` |
| Depth | Standard (5-8 pages) | `--quick` (homepage + 2), `--deep` (10-15 pages) |
| Auth | None | `Sign in as user@example.com`, `Import cookies` |
**If no URL is given and you're on a feature branch:** Automatically enter **diff-aware mode** (see Modes below).
**If no URL is given and you're on main/master:** Ask the user for a URL.
**Check for DESIGN.md:**
Look for `DESIGN.md`, `design-system.md`, or similar in the repo root. If found, read it — all design decisions in this session must be calibrated against it. Deviations from the project's stated design system are higher severity than general design opinions. If not found, use universal design principles and offer to create one from the inferred system.
**Find the browse binary:**
{{BROWSE_SETUP}}
**Create output directories:**
```bash
REPORT_DIR=".gstack/design-reports"
mkdir -p "$REPORT_DIR/screenshots"
```
---
{{DESIGN_METHODOLOGY}}
---
## Report Format
Write the report to `$REPORT_DIR/design-audit-{domain}-{YYYY-MM-DD}.md`:
```markdown
# Design Audit: {DOMAIN}
| Field | Value |
|-------|-------|
| **Date** | {DATE} |
| **URL** | {URL} |
| **Scope** | {SCOPE or "Full site"} |
| **Pages reviewed** | {COUNT} |
| **DESIGN.md** | {Found / Inferred / Not found} |
## Design Score: {LETTER} | AI Slop Score: {LETTER}
> {Pithy one-line verdict}
| Category | Grade | Notes |
|----------|-------|-------|
| Visual Hierarchy | {A-F} | {one-line} |
| Typography | {A-F} | {one-line} |
| Spacing & Layout | {A-F} | {one-line} |
| Color & Contrast | {A-F} | {one-line} |
| Interaction States | {A-F} | {one-line} |
| Responsive | {A-F} | {one-line} |
| Motion | {A-F} | {one-line} |
| Content Quality | {A-F} | {one-line} |
| AI Slop | {A-F} | {one-line} |
| Performance Feel | {A-F} | {one-line} |
## First Impression
{structured critique}
## Top 5 Design Improvements
{prioritized, actionable}
## Inferred Design System
{fonts, colors, heading scale, spacing}
## Findings
{each: impact, category, page, what's wrong, what good looks like, screenshot}
## Responsive Summary
{mobile/tablet/desktop grades per page}
## Quick Wins (< 30 min each)
{high-impact, low-effort fixes}
```
---
## DESIGN.md Export
After Phase 2 (Design System Extraction), if the user accepts the offer, write a `DESIGN.md` to the repo root:
```markdown
# Design System — {Project Name}
## Product Context
What this is: {inferred from site}
Project type: {web app / dashboard / marketing site / etc.}
## Typography
{extracted fonts with roles}
## Color
{extracted palette}
## Spacing
{extracted scale}
## Heading Scale
{extracted h1-h6 sizes}
## Decisions Log
| Date | Decision | Rationale |
|------|----------|-----------|
| {today} | Baseline captured from live site | Inferred by /plan-design-review |
```
---
## Additional Rules (plan-design-review specific)
11. **Never fix anything.** Find and document only. Do not read source code, edit files, or suggest code fixes. Your job is to report what could be better and suggest design improvements. Use `/qa-design-review` for the fix loop.
12. **The exception:** You MAY write a DESIGN.md file if the user accepts the offer. This is the only file you create.