ui-ux-master 1.2.1 → 1.5.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/README.md +160 -209
- package/SKILL.md +89 -47
- package/docs/package-publishing.md +5 -3
- package/index.cjs +3 -1
- package/index.d.ts +1 -1
- package/index.mjs +4 -1
- package/package.json +4 -3
- package/references/brand-method-card-based-discovery.md +285 -0
- package/references/brand-method-conversion-simplicity.md +276 -0
- package/references/brand-method-ecosystem-bundling.md +263 -0
- package/references/brand-method-editorial-brand-world.md +265 -0
- package/references/brand-method-enterprise-trust-hub.md +298 -0
- package/references/brand-method-playful-familiarity.md +284 -0
- package/references/brand-method-premium-restraint.md +270 -0
- package/references/brand-method-product-cinema.md +258 -0
- package/references/brand-method-technical-authority.md +290 -0
- package/references/brand-method-utility-command-center.md +278 -0
- package/references/color-psychology-branding.md +286 -0
- package/references/color-scale-system.md +347 -0
- package/references/competitive-landscape.md +32 -6
- package/references/design-discovery-protocol.md +171 -0
- package/references/design-system-schema.md +407 -0
- package/references/industry-reasoning-rules.md +504 -0
- package/references/landing-page-patterns.md +327 -0
- package/references/output-quality-gates.md +246 -0
- package/references/tech-stack-guidelines.md +636 -0
- package/references/ui-styles-catalog.md +552 -0
- package/references/visual-directions.md +362 -0
- package/tests/install-smoke.test.mjs +93 -12
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
# Brand Method: Product Cinema
|
|
2
|
+
|
|
3
|
+
Use this skill when building for premium products, hardware, AI products, automotive, luxury goods, creator tools, or any brand where the product itself is the hero.
|
|
4
|
+
|
|
5
|
+
Reference brands: Apple, Tesla, Mercedes-Benz, Porsche, Rolex, Audi, Sony PlayStation, Samsung, BMW.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## When to Apply This Method
|
|
10
|
+
|
|
11
|
+
Apply Product Cinema when:
|
|
12
|
+
- The product has strong visual appeal or engineering craft.
|
|
13
|
+
- The brand commands premium pricing and aspiration.
|
|
14
|
+
- The primary goal is desire, trust, and direct purchase or configuration.
|
|
15
|
+
- The user journey is: discover → desire → configure/buy.
|
|
16
|
+
|
|
17
|
+
Do not apply when:
|
|
18
|
+
- The product is commodity, utility-first, or price-sensitive.
|
|
19
|
+
- The primary task is search, compare, or track.
|
|
20
|
+
- The brand is playful, enterprise-B2B, or social.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Layout Structure
|
|
25
|
+
|
|
26
|
+
### Hero Section
|
|
27
|
+
- Full-viewport (100vw × 100vh) product image or video.
|
|
28
|
+
- Product centered or offset-right with breathing room.
|
|
29
|
+
- Minimal overlay: one eyebrow label (optional), one H1 (product name or single claim), one 14-18px supporting sentence, 1-2 CTAs.
|
|
30
|
+
- CTA placement: bottom-center or bottom-left, never covering the product.
|
|
31
|
+
- No decorative gradients over the product. Let the product speak.
|
|
32
|
+
|
|
33
|
+
### Scroll Reveal Sections (in order)
|
|
34
|
+
1. **Product story / film** — motion reveals or cinematic zoom showing key features.
|
|
35
|
+
2. **Key benefit blocks** — 3-4 full-width sections, one benefit each, alternating image/text.
|
|
36
|
+
3. **Specifications** — clean table or card grid, minimal chrome.
|
|
37
|
+
4. **Ecosystem / accessories** — horizontal scroll or grid of related products.
|
|
38
|
+
5. **Social proof** — awards, press quotes, review aggregate. Never more than 3 sources.
|
|
39
|
+
6. **Final CTA** — sticky or section-level, repeated from hero.
|
|
40
|
+
|
|
41
|
+
### Navigation
|
|
42
|
+
- Minimal sticky nav: logo left, 3-5 links max, one CTA right.
|
|
43
|
+
- On scroll: nav becomes translucent or colored, never opaque-white over hero.
|
|
44
|
+
- Mobile: hamburger with full-screen overlay, not a drawer.
|
|
45
|
+
|
|
46
|
+
### Footer
|
|
47
|
+
- Minimal. Legal, links, social icons. Never crowded.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Color Scheme
|
|
52
|
+
|
|
53
|
+
### Primary Palette (choose one direction)
|
|
54
|
+
|
|
55
|
+
**Light / Clean Premium**
|
|
56
|
+
- Background: `#FFFFFF` or `#F5F5F7`
|
|
57
|
+
- Surface: `#FAFAFA`
|
|
58
|
+
- Primary text: `#1D1D1F`
|
|
59
|
+
- Secondary text: `#6E6E73`
|
|
60
|
+
- CTA: Brand accent (e.g., `#0071E3` for tech, `#BB0000` for automotive)
|
|
61
|
+
- Border/divider: `#D2D2D7`
|
|
62
|
+
|
|
63
|
+
**Dark / Cinematic**
|
|
64
|
+
- Background: `#000000` or `#0A0A0A`
|
|
65
|
+
- Surface: `#161617`
|
|
66
|
+
- Primary text: `#F5F5F7`
|
|
67
|
+
- Secondary text: `#A1A1A6`
|
|
68
|
+
- CTA: High-contrast accent (`#FFFFFF` text on dark, or vivid color button)
|
|
69
|
+
- Border/divider: `#2C2C2E`
|
|
70
|
+
|
|
71
|
+
### Accent Colors by Sub-Category
|
|
72
|
+
| Sub-category | Accent examples |
|
|
73
|
+
|---|---|
|
|
74
|
+
| Consumer tech | Blue `#0071E3`, silver `#8E8E93` |
|
|
75
|
+
| Luxury automotive | Red `#CC0000`, gold `#B8860B`, silver |
|
|
76
|
+
| Premium watches / jewelry | Gold `#D4A017`, deep green `#1B4332`, heritage red |
|
|
77
|
+
| Creator tools | Vivid gradient accent on dark surface |
|
|
78
|
+
| Luxury fashion | Cream `#F5F0E8`, gold, black |
|
|
79
|
+
|
|
80
|
+
### Rules
|
|
81
|
+
- Maximum 3 colors in active use at any time (background, text, accent).
|
|
82
|
+
- Never use more than one accent color per viewport.
|
|
83
|
+
- Gradient: allowed only on the accent CTA button or as a product surface glow, never as a background.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Typography
|
|
88
|
+
|
|
89
|
+
### Scale
|
|
90
|
+
| Role | Size | Weight | Style |
|
|
91
|
+
|---|---|---|---|
|
|
92
|
+
| Eyebrow | 11-12px | 500-600 | All-caps, tracked +0.08em |
|
|
93
|
+
| H1 / Product name | 48-80px | 600-700 | Tight tracking −0.01em to −0.03em |
|
|
94
|
+
| H2 / Section headline | 28-40px | 600 | Tight |
|
|
95
|
+
| Body / benefit copy | 17-21px | 400 | Normal tracking, 1.6 line-height |
|
|
96
|
+
| Spec label | 11-13px | 500 | All-caps, tracked |
|
|
97
|
+
| Spec value | 14-17px | 400-500 | Tabular numerals |
|
|
98
|
+
| CTA | 14-17px | 500-600 | Normal tracking |
|
|
99
|
+
|
|
100
|
+
### Font Pairings
|
|
101
|
+
| Brand type | Heading | Body |
|
|
102
|
+
|---|---|---|
|
|
103
|
+
| Consumer tech | SF Pro Display (system), or Inter | SF Pro Text, Inter |
|
|
104
|
+
| Luxury automotive | Gill Sans, Optima, or custom serif | Helvetica Neue, Inter |
|
|
105
|
+
| Luxury watches/jewelry | Didot, Cormorant Garamond | Futura, Montserrat |
|
|
106
|
+
| Premium lifestyle | Playfair Display | Lato, Source Sans |
|
|
107
|
+
|
|
108
|
+
### Rules
|
|
109
|
+
- Never use more than 2 font families.
|
|
110
|
+
- Headlines must be large enough to command attention before any image does.
|
|
111
|
+
- Avoid system emoji or decorative fonts.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Spacing System
|
|
116
|
+
|
|
117
|
+
| Token | Value | Use |
|
|
118
|
+
|---|---|---|
|
|
119
|
+
| `--space-xs` | 4px | Icon gaps, inline nudges |
|
|
120
|
+
| `--space-sm` | 8px | Label spacing, tight stacks |
|
|
121
|
+
| `--space-md` | 16px | Component padding |
|
|
122
|
+
| `--space-lg` | 32px | Section inner padding |
|
|
123
|
+
| `--space-xl` | 64px | Between content blocks |
|
|
124
|
+
| `--space-2xl` | 96-128px | Hero breathing room, section separators |
|
|
125
|
+
| `--space-3xl` | 160-200px | Full-screen section padding top/bottom |
|
|
126
|
+
|
|
127
|
+
- Sections must breathe. Minimum 96px padding between major content blocks on desktop.
|
|
128
|
+
- On mobile: scale down by ~40%, but never below 24px section separation.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Motion and Interaction
|
|
133
|
+
|
|
134
|
+
### Scroll-Driven Animation
|
|
135
|
+
- Parallax: product image moves at 0.8× scroll speed relative to background.
|
|
136
|
+
- Fade-in on scroll: `opacity 0→1`, `translateY 20px→0`, duration 400-600ms, ease-out.
|
|
137
|
+
- Never animate text before the user has had 300ms to read it.
|
|
138
|
+
|
|
139
|
+
### CTA States
|
|
140
|
+
| State | Effect |
|
|
141
|
+
|---|---|
|
|
142
|
+
| Default | Brand accent background, white text |
|
|
143
|
+
| Hover | Darken 8-12% or subtle scale `1.02` |
|
|
144
|
+
| Active | Scale `0.98`, darken further |
|
|
145
|
+
| Focus | 2-3px offset focus ring, brand color or `#0071E3` |
|
|
146
|
+
| Loading | Spinner inside button, text hidden or replaced |
|
|
147
|
+
| Disabled | 40% opacity, no pointer events |
|
|
148
|
+
|
|
149
|
+
### Video / Motion Rules
|
|
150
|
+
- Autoplay: allowed for hero video if: muted, no audio track, `prefers-reduced-motion` respected.
|
|
151
|
+
- Provide poster image fallback.
|
|
152
|
+
- Never autoplay audio.
|
|
153
|
+
- Reduced motion: replace parallax and scroll animation with instant transitions.
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## Responsive Behavior
|
|
158
|
+
|
|
159
|
+
| Breakpoint | Key changes |
|
|
160
|
+
|---|---|
|
|
161
|
+
| Mobile 375px | Full-bleed hero image, product fills screen, CTA stacks vertically, type H1 scales to 32-40px |
|
|
162
|
+
| Tablet 768px | Two-column benefit layout, nav collapses to hamburger |
|
|
163
|
+
| Desktop 1024px | Full layout, scroll animations active |
|
|
164
|
+
| Wide 1440px+ | Max content width `1280px` centered, hero fills viewport edge-to-edge |
|
|
165
|
+
|
|
166
|
+
- On mobile: remove parallax, replace with static scroll.
|
|
167
|
+
- On mobile: sticky CTA bar at bottom for primary action.
|
|
168
|
+
- Images: use `srcset` or responsive image format (WebP/AVIF). Never serve desktop hero at mobile.
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## Accessibility Requirements
|
|
173
|
+
|
|
174
|
+
- Color contrast: minimum 4.5:1 for body text, 3:1 for large text/UI components.
|
|
175
|
+
- On dark cinematic surfaces: white text `#F5F5F7` on `#000000` = 21:1 — always passes.
|
|
176
|
+
- On hero image overlays: always add a semi-transparent scrim (`rgba(0,0,0,0.4)` minimum) before placing text.
|
|
177
|
+
- `prefers-reduced-motion`: wrap all scroll animations in `@media (prefers-reduced-motion: no-preference)`.
|
|
178
|
+
- Video: must have `aria-label`, pause control, and `prefers-reduced-motion` stops autoplay.
|
|
179
|
+
- CTA buttons: always have visible text label, never icon-only.
|
|
180
|
+
- Focus indicators: `outline: 2px solid <accent>; outline-offset: 3px` — never `outline: none` without custom focus style.
|
|
181
|
+
- Keyboard: all interactive elements reachable, logical tab order follows visual order.
|
|
182
|
+
- Screen reader: hero heading must be an `<h1>`, not a `<div>`. Product name = page title.
|
|
183
|
+
- Images: `alt` text describes the product and context, not just "product image".
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## UX Principles for This Method
|
|
188
|
+
|
|
189
|
+
1. **Confidence over explanation.** Premium brands do not over-explain. One claim. One proof. Move on.
|
|
190
|
+
2. **Product is the hero.** Every layout decision protects the product's visual dominance.
|
|
191
|
+
3. **Reduce friction to desire.** The user should feel the product is within reach before they see a price.
|
|
192
|
+
4. **CTA placement follows desire.** Place CTA after the moment of maximum desire, not immediately at load.
|
|
193
|
+
5. **Consistency of restraint.** Every added element costs attention. Default to removing, not adding.
|
|
194
|
+
6. **Configurator UX.** If the product is configurable: show the default beautifully, let the user modify progressively, never show all options at once.
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
## Component Specs
|
|
199
|
+
|
|
200
|
+
### Hero CTA Button
|
|
201
|
+
```
|
|
202
|
+
Background: brand accent
|
|
203
|
+
Text: contrasting (white on dark, near-black on light)
|
|
204
|
+
Padding: 14px 28px
|
|
205
|
+
Border-radius: 6-8px (tech) | 0-2px (ultra luxury) | 20px (lifestyle)
|
|
206
|
+
Font: 15-17px, weight 500-600
|
|
207
|
+
Transition: background 180ms ease, transform 120ms ease
|
|
208
|
+
Min-width: 140px
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Spec Table
|
|
212
|
+
```
|
|
213
|
+
Cell padding: 12px 16px
|
|
214
|
+
Border: 1px solid var(--border)
|
|
215
|
+
Header row: background var(--surface), font-weight 600, font-size 11px all-caps
|
|
216
|
+
Value rows: alternating subtle background on hover
|
|
217
|
+
Numbers: tabular-nums
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Sticky Nav
|
|
221
|
+
```
|
|
222
|
+
Position: fixed top 0
|
|
223
|
+
Height: 44-52px
|
|
224
|
+
Backdrop: blur(20px) saturate(180%) with semi-transparent background
|
|
225
|
+
Transition: background 200ms ease on scroll
|
|
226
|
+
Z-index: 1000
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## Anti-Patterns to Avoid
|
|
232
|
+
|
|
233
|
+
- Do not clutter the hero with more than 2 CTAs.
|
|
234
|
+
- Do not use stock photography — use real product photography or none.
|
|
235
|
+
- Do not use discount badges, countdown timers, or urgency copy.
|
|
236
|
+
- Do not use carousels in hero — they reduce impact and have poor accessibility.
|
|
237
|
+
- Do not use full-width decorative gradients as backgrounds — they cheapen premium perception.
|
|
238
|
+
- Do not mix dark and light sections without deliberate contrast logic.
|
|
239
|
+
- Do not use multiple accent colors on the same page — pick one.
|
|
240
|
+
- Do not put the specification table above the benefit/story section.
|
|
241
|
+
- Do not use hover-only navigation — touch users cannot hover.
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## QA Checklist
|
|
246
|
+
|
|
247
|
+
- [ ] Hero image/video loads with correct poster/fallback.
|
|
248
|
+
- [ ] `prefers-reduced-motion` stops or reduces animation.
|
|
249
|
+
- [ ] All text passes 4.5:1 contrast (use browser accessibility audit).
|
|
250
|
+
- [ ] Sticky nav visible and usable at all scroll positions.
|
|
251
|
+
- [ ] CTA button has visible focus ring.
|
|
252
|
+
- [ ] All images have meaningful `alt` text.
|
|
253
|
+
- [ ] H1 exists and is the product/brand name.
|
|
254
|
+
- [ ] Mobile 375px: hero fills screen, CTA accessible without scroll.
|
|
255
|
+
- [ ] Keyboard: tab through all interactive elements without mouse.
|
|
256
|
+
- [ ] Screen reader: hero heading, CTA label, product description all announced correctly.
|
|
257
|
+
- [ ] No autoplay audio.
|
|
258
|
+
- [ ] Page loads in under 3s on 4G (Core Web Vitals: LCP ≤ 2.5s).
|
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
# Brand Method: Technical Authority
|
|
2
|
+
|
|
3
|
+
Use this skill when building for AI platforms, developer tools, semiconductors, infrastructure, cloud computing, or any context where the buyer/user evaluates credibility through technical depth, performance data, and precision.
|
|
4
|
+
|
|
5
|
+
Reference brands: NVIDIA, Intel, AMD, Qualcomm, IBM, Cisco (developer), AWS, Vercel, Cloudflare, Stripe (developer docs), GitHub, Figma (developer).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## When to Apply This Method
|
|
10
|
+
|
|
11
|
+
Apply Technical Authority when:
|
|
12
|
+
- The audience is developers, engineers, architects, data scientists, or technical decision-makers.
|
|
13
|
+
- The product's value is measured in specs, benchmarks, throughput, latency, or compatibility.
|
|
14
|
+
- Credibility is demonstrated through diagrams, code, architecture, and precision.
|
|
15
|
+
- The primary user actions are: read docs, run a benchmark, integrate, download SDK.
|
|
16
|
+
|
|
17
|
+
Do not apply when:
|
|
18
|
+
- The audience is non-technical business buyers (use Enterprise Trust Hub).
|
|
19
|
+
- The product is consumer-facing (use Product Cinema, Playful Familiarity, or Conversion Simplicity).
|
|
20
|
+
- The brand leads with campaign/culture storytelling (use Editorial Brand World).
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Layout Structure
|
|
25
|
+
|
|
26
|
+
### Hero
|
|
27
|
+
- Technical claim: specific, measurable. "3× faster inference." "Sub-10ms global latency." Never vague.
|
|
28
|
+
- Visual: architecture diagram, code snippet, or benchmark chart.
|
|
29
|
+
- CTA: "Get Started", "View Docs", "Run in Browser", "Download SDK."
|
|
30
|
+
- Sub-CTA: GitHub stars badge, npm install command, version badge.
|
|
31
|
+
|
|
32
|
+
### Navigation
|
|
33
|
+
- Logo left.
|
|
34
|
+
- Navigation: Product, Docs, Pricing, Blog, GitHub link, Login, primary CTA.
|
|
35
|
+
- Docs always reachable in 1 click from any page.
|
|
36
|
+
- Search: prominent, especially on docs pages.
|
|
37
|
+
- Dark or light depending on brand — NVIDIA black, Vercel black/white, AWS dark navy.
|
|
38
|
+
|
|
39
|
+
### Homepage (in order)
|
|
40
|
+
1. **Hero** — technical claim, CTA, code/visual proof.
|
|
41
|
+
2. **Social proof** — companies using it (logos) or GitHub star count, npm downloads.
|
|
42
|
+
3. **Core capabilities** — 3-4 technical capabilities with icons, precise description, link to docs.
|
|
43
|
+
4. **Architecture diagram** — how the product fits into a user's stack.
|
|
44
|
+
5. **Performance proof** — benchmark chart, speed comparison table, or numbers with methodology.
|
|
45
|
+
6. **Integration logos** — compatible tools and platforms.
|
|
46
|
+
7. **Code example** — real, runnable snippet showing the simplest useful thing.
|
|
47
|
+
8. **CTA section** — "Start building" with install command.
|
|
48
|
+
|
|
49
|
+
### Docs Pages
|
|
50
|
+
- Sidebar navigation: collapsible tree, search, current page highlighted.
|
|
51
|
+
- Content: full-width readable column (max 720px), code blocks right or inline.
|
|
52
|
+
- Code blocks: syntax highlighting, copy button, language label.
|
|
53
|
+
- Table of contents: right sidebar on desktop.
|
|
54
|
+
- Breadcrumb: always.
|
|
55
|
+
- "Edit this page" link: bottom of every doc.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Color Scheme
|
|
60
|
+
|
|
61
|
+
### Palette Archetypes
|
|
62
|
+
|
|
63
|
+
**Dark Technical (NVIDIA, Vercel, Linear)**
|
|
64
|
+
- Background: `#0A0A0A` or `#111111`
|
|
65
|
+
- Surface: `#1A1A1A` or `#161616`
|
|
66
|
+
- Text: `#EDEDED` or `#F0F0F0`
|
|
67
|
+
- Secondary text: `#A3A3A3`
|
|
68
|
+
- Accent (NVIDIA green): `#76B900`
|
|
69
|
+
- Accent (Vercel): `#FFFFFF` or subtle indigo
|
|
70
|
+
- Border: `#2A2A2A`
|
|
71
|
+
- Code block background: `#1E1E1E` (VS Code Dark-like)
|
|
72
|
+
- Syntax: strings `#CE9178`, keywords `#569CD6`, comments `#6A9955`, numbers `#B5CEA8`
|
|
73
|
+
|
|
74
|
+
**Light Technical (AWS, Stripe, GitHub)**
|
|
75
|
+
- Background: `#FFFFFF`
|
|
76
|
+
- Surface: `#F6F8FA` (GitHub) or `#F4F6F9`
|
|
77
|
+
- Text: `#1A1A1A`
|
|
78
|
+
- Secondary text: `#57606A`
|
|
79
|
+
- Primary: `#0969DA` (GitHub blue), `#FF9900` (AWS orange), `#635BFF` (Stripe purple)
|
|
80
|
+
- Border: `#D0D7DE`
|
|
81
|
+
- Code block background: `#F6F8FA`
|
|
82
|
+
|
|
83
|
+
**Semiconductor / Infrastructure (Intel, Cisco)**
|
|
84
|
+
- Background: `#FFFFFF`
|
|
85
|
+
- Primary: Intel blue `#0068B5`, Cisco blue `#1BA0D7`
|
|
86
|
+
- Surface: `#F5F7FA`
|
|
87
|
+
- Text: `#1A1A1A`
|
|
88
|
+
- Accent: brand blue
|
|
89
|
+
- Code: light mode syntax
|
|
90
|
+
|
|
91
|
+
### Rules
|
|
92
|
+
- Dark surfaces: excellent for developer tools — developers associate dark mode with code environments.
|
|
93
|
+
- Accent color: used only for links, CTAs, active states, and syntax highlights.
|
|
94
|
+
- Green accents (NVIDIA): only one use per viewport — for performance/success signals.
|
|
95
|
+
- Never use gradient backgrounds in technical authority contexts — precision, not decoration.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Typography
|
|
100
|
+
|
|
101
|
+
### Scale
|
|
102
|
+
| Role | Size | Weight | Notes |
|
|
103
|
+
|---|---|---|---|
|
|
104
|
+
| Hero claim | 36-56px | 700 | Specific and measurable |
|
|
105
|
+
| Hero sub | 17-20px | 400 | Technical context sentence |
|
|
106
|
+
| Section headline | 24-32px | 600-700 | |
|
|
107
|
+
| Feature title | 18-20px | 600 | |
|
|
108
|
+
| Feature body | 14-16px | 400 | |
|
|
109
|
+
| Code (inline) | 13-14px | 400 | Monospace |
|
|
110
|
+
| Code (block) | 12-14px | 400 | Monospace |
|
|
111
|
+
| Benchmark number | 40-60px | 700 | Tabular, brand accent |
|
|
112
|
+
| Nav | 13-14px | 500 | |
|
|
113
|
+
| Badge | 11px | 600 | Version, status |
|
|
114
|
+
|
|
115
|
+
### Font Pairings
|
|
116
|
+
| Context | Heading | Body | Code |
|
|
117
|
+
|---|---|---|---|
|
|
118
|
+
| AI / developer | Geist (Vercel), Inter | Inter, Geist | Geist Mono, JetBrains Mono |
|
|
119
|
+
| Infrastructure | Helvetica Neue, Inter | Helvetica Neue | Fira Code, Cascadia Code |
|
|
120
|
+
| Semiconductor | Intel Clear, or Roboto | Roboto, Inter | Roboto Mono |
|
|
121
|
+
| Dev tool (light) | GitHub's Mona Sans, or Inter | Inter | GitHub Monaspace or JetBrains Mono |
|
|
122
|
+
|
|
123
|
+
### Rules
|
|
124
|
+
- Monospace code font must be installed and loaded — never fall back to `monospace` alone.
|
|
125
|
+
- Technical numbers (benchmarks): tabular numerals, bold, large — data is the argument.
|
|
126
|
+
- Inline code: `background: var(--code-bg)`, `border-radius: 4px`, `padding: 2px 6px`, `font-family: monospace`.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Spacing System
|
|
131
|
+
|
|
132
|
+
| Token | Value | Use |
|
|
133
|
+
|---|---|---|
|
|
134
|
+
| `--space-xs` | 4px | Inline code gaps, badge padding |
|
|
135
|
+
| `--space-sm` | 8px | List item gaps, icon margins |
|
|
136
|
+
| `--space-md` | 16px | Component padding, form inputs |
|
|
137
|
+
| `--space-lg` | 24-32px | Between feature blocks |
|
|
138
|
+
| `--space-xl` | 48-64px | Section separation |
|
|
139
|
+
| `--space-2xl` | 80-96px | Hero, benchmark section |
|
|
140
|
+
|
|
141
|
+
- Docs: body content max-width 720px, line-height 1.7 for readability.
|
|
142
|
+
- Code blocks: padding 16-20px, line-height 1.5.
|
|
143
|
+
- Benchmark section: generous — numbers need room to be impressive.
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## Motion and Interaction
|
|
148
|
+
|
|
149
|
+
### Principles
|
|
150
|
+
- Minimal animation — technical users are not impressed by flourishes, but are annoyed by delays.
|
|
151
|
+
- Benchmark number count-up on scroll: 0 → final value, 800ms ease-out.
|
|
152
|
+
- Architecture diagram: SVG with nodes appearing in sequence on scroll (200ms stagger).
|
|
153
|
+
- Code block: syntax highlighting is the visual — no animation needed.
|
|
154
|
+
|
|
155
|
+
### Code Interaction
|
|
156
|
+
- Copy button: appears on hover of code block, top-right corner. `aria-label="Copy code"`.
|
|
157
|
+
- On copy: button changes to "Copied!" for 2 seconds, then reverts.
|
|
158
|
+
- Code line highlights: specific lines highlighted with left border + background for callouts.
|
|
159
|
+
- Terminal simulation: character-by-character typing of install command, 50ms per char, 300ms delay before start.
|
|
160
|
+
|
|
161
|
+
### Performance Benchmark
|
|
162
|
+
- Bar chart animation: bars grow from 0 to value, 600ms, ease-out, staggered 100ms.
|
|
163
|
+
- Comparison table: scroll-activated row highlights.
|
|
164
|
+
|
|
165
|
+
### `prefers-reduced-motion`
|
|
166
|
+
- Skip all count-ups, diagram sequences, and terminal typing animations.
|
|
167
|
+
- Show final state immediately.
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
## Responsive Behavior
|
|
172
|
+
|
|
173
|
+
| Breakpoint | Key changes |
|
|
174
|
+
|---|---|
|
|
175
|
+
| Mobile 375px | Single column. Code blocks: horizontal scroll. Docs sidebar: off-canvas. Hero claim: 28-36px. Benchmark numbers: single column. Architecture diagram: scrollable or simplified. |
|
|
176
|
+
| Tablet 768px | Docs: collapsible sidebar. Homepage: 2-column capabilities. |
|
|
177
|
+
| Desktop 1024px | Full sidebar on docs. Side-by-side code + description. Architecture diagram full size. |
|
|
178
|
+
| Wide 1440px+ | Max-width 1280px. Three-column docs (nav + content + ToC). |
|
|
179
|
+
|
|
180
|
+
- Mobile code blocks: always horizontal scroll, never wrap — broken code is broken.
|
|
181
|
+
- Mobile docs: off-canvas sidebar accessible via hamburger.
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Accessibility Requirements
|
|
186
|
+
|
|
187
|
+
- Code blocks: `<pre><code role="region" aria-label="Code example: [language]">`. Copy button accessible.
|
|
188
|
+
- Benchmark charts: provide a data table alternative or aria-described fallback. Never chart-only.
|
|
189
|
+
- Architecture diagram: `<figure>` with `<figcaption>` text description of what the diagram shows.
|
|
190
|
+
- Terminal animation: provide static text alternative for screen readers.
|
|
191
|
+
- Docs navigation: `<nav aria-label="Documentation">`, current page `aria-current="page"`.
|
|
192
|
+
- Search: `role="search"`, results `role="listbox"`, keyboard navigable.
|
|
193
|
+
- Version badge: `aria-label="Version 3.2.1"`.
|
|
194
|
+
- Dark mode: syntax highlighting must maintain 4.5:1 contrast. Verify strings, keywords, and comments all pass.
|
|
195
|
+
- Tables (comparison, compatibility): `<th scope="col/row">`, proper header associations.
|
|
196
|
+
- "Edit this page" GitHub link: descriptive `aria-label` including page title.
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## UX Principles for This Method
|
|
201
|
+
|
|
202
|
+
1. **Claims require proof.** Every marketing claim must be followed by a spec, benchmark, or code example within the same viewport.
|
|
203
|
+
2. **Docs are the product.** For developer tools, the documentation experience IS the product experience.
|
|
204
|
+
3. **Make the first success fast.** Show the simplest useful thing in the first code block. Developers test before they commit.
|
|
205
|
+
4. **Precision over personality.** Numbers over stories. Diagrams over illustrations. Code over description.
|
|
206
|
+
5. **Performance is a feature.** A slow documentation site is a credibility problem.
|
|
207
|
+
6. **Trust the reader.** Don't oversimplify or over-explain. Technical audiences respect when you give them the detail they need.
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## Component Specs
|
|
212
|
+
|
|
213
|
+
### Code Block
|
|
214
|
+
```
|
|
215
|
+
Background: #1E1E1E (dark) or #F6F8FA (light)
|
|
216
|
+
Border-radius: 8px
|
|
217
|
+
Padding: 16-20px
|
|
218
|
+
Font: JetBrains Mono, Geist Mono, or Fira Code, 13-14px
|
|
219
|
+
Line-height: 1.5
|
|
220
|
+
Language label: top-left, 11px, all-caps, text-muted
|
|
221
|
+
Copy button: top-right, 14px icon, transparent button, hover: surface background
|
|
222
|
+
Horizontal scroll: always on overflow, never wrap
|
|
223
|
+
Line number gutter: optional, 40px wide, text-muted
|
|
224
|
+
Highlight line: left border 3px accent, background rgba(accent, 0.1)
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Architecture Diagram
|
|
228
|
+
```
|
|
229
|
+
Container: full-width, background: var(--surface)
|
|
230
|
+
Border-radius: 12px
|
|
231
|
+
Padding: 32px
|
|
232
|
+
SVG or image: max-width 100%, responsive
|
|
233
|
+
Node labels: 11-13px, clean, monospace or sans
|
|
234
|
+
Arrows: 1.5-2px, brand accent or muted
|
|
235
|
+
Legend: below diagram, 12px, inline color swatches
|
|
236
|
+
Figcaption: below, 13px, text-secondary
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
### Benchmark Bar Chart
|
|
240
|
+
```
|
|
241
|
+
Container: grid of bars
|
|
242
|
+
Bar background: var(--surface-2)
|
|
243
|
+
Bar fill: brand accent (for "our product"), neutral for competitors
|
|
244
|
+
Bar height: 40-48px
|
|
245
|
+
Label: left of bar, 13-14px
|
|
246
|
+
Value: right of bar, 14-16px bold, brand accent for highest
|
|
247
|
+
Source footnote: 12px, text-muted, below chart
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Install Command Display
|
|
251
|
+
```
|
|
252
|
+
Background: var(--code-bg)
|
|
253
|
+
Border-radius: 8px
|
|
254
|
+
Padding: 12px 16px
|
|
255
|
+
Font: monospace, 14px
|
|
256
|
+
Prompt: $ symbol, text-muted
|
|
257
|
+
Command: text-primary
|
|
258
|
+
Copy icon: right side
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## Anti-Patterns to Avoid
|
|
264
|
+
|
|
265
|
+
- Do not make unverifiable performance claims without benchmarks or methodology.
|
|
266
|
+
- Do not show only marketing copy on the homepage — developers will bounce without a code example.
|
|
267
|
+
- Do not bury the docs link — technical users look for it first.
|
|
268
|
+
- Do not use syntax-error-prone code examples — all code shown must be correct and runnable.
|
|
269
|
+
- Do not use line-wrapped code blocks — broken code destroys technical credibility.
|
|
270
|
+
- Do not use animations that fire on scroll over benchmark numbers if they require JavaScript that blocks render.
|
|
271
|
+
- Do not use "email to see pricing" for developer tools — pricing must be public.
|
|
272
|
+
- Do not use generic stock photos of servers, cables, or data centers — use diagrams and screenshots.
|
|
273
|
+
|
|
274
|
+
---
|
|
275
|
+
|
|
276
|
+
## QA Checklist
|
|
277
|
+
|
|
278
|
+
- [ ] Hero claim is specific and measurable — no generic "fast" or "powerful."
|
|
279
|
+
- [ ] At least one real, runnable code example on the homepage.
|
|
280
|
+
- [ ] Docs link accessible from homepage in one click.
|
|
281
|
+
- [ ] Code blocks: horizontal scroll, not wrap, on mobile.
|
|
282
|
+
- [ ] Copy button: works, shows "Copied!" confirmation, has `aria-label`.
|
|
283
|
+
- [ ] Benchmark chart has data table fallback or `aria-describedby` text.
|
|
284
|
+
- [ ] Architecture diagram has `<figcaption>` text description.
|
|
285
|
+
- [ ] All dark-mode syntax highlighting passes 4.5:1 contrast.
|
|
286
|
+
- [ ] Docs search: keyboard accessible, results announced to screen reader.
|
|
287
|
+
- [ ] Version badges have `aria-label`.
|
|
288
|
+
- [ ] `prefers-reduced-motion`: no count-up animations, no typing animations.
|
|
289
|
+
- [ ] Pricing visible — no "contact sales for pricing" for developer products.
|
|
290
|
+
- [ ] Page LCP ≤ 2.5s — technical users will measure this.
|