mirror of
https://github.com/pbakaus/impeccable.git
synced 2026-09-12 06:06:37 +03:00
Mark arrange, normalize, onboard, extract as DEPRECATED in source
The build counts active commands by checking for DEPRECATED in the skill description. Without this, the old source files were still counted as active (22) while the site says 18, failing CI. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Paul Bakaus
co-authored by
Claude Opus 4.6
Claude Opus 4.6
parent
8c480843e7
commit
5a22894b1f
@@ -1,124 +1,8 @@
|
||||
---
|
||||
name: arrange
|
||||
description: "Improve layout, spacing, and visual rhythm. Fixes monotonous grids, inconsistent spacing, and weak visual hierarchy. Use when the user mentions layout feeling off, spacing issues, visual hierarchy, crowded UI, alignment problems, or wanting better composition."
|
||||
argument-hint: "[target]"
|
||||
user-invocable: true
|
||||
description: "DEPRECATED: This skill has been renamed to 'layout'. Run /layout instead."
|
||||
---
|
||||
|
||||
Assess and improve layout and spacing that feels monotonous, crowded, or structurally weak — turning generic arrangements into intentional, rhythmic compositions.
|
||||
This skill has been renamed to **layout**. Run `{{command_prefix}}layout` instead.
|
||||
|
||||
## MANDATORY PREPARATION
|
||||
|
||||
Invoke {{command_prefix}}impeccable — it contains design principles, anti-patterns, and the **Context Gathering Protocol**. Follow the protocol before proceeding — if no design context exists yet, you MUST run {{command_prefix}}impeccable teach first.
|
||||
|
||||
---
|
||||
|
||||
## Assess Current Layout
|
||||
|
||||
Analyze what's weak about the current spatial design:
|
||||
|
||||
1. **Spacing**:
|
||||
- Is spacing consistent or arbitrary? (Random padding/margin values)
|
||||
- Is all spacing the same? (Equal padding everywhere = no rhythm)
|
||||
- Are related elements grouped tightly, with generous space between groups?
|
||||
|
||||
2. **Visual hierarchy**:
|
||||
- Apply the squint test: blur your (metaphorical) eyes — can you still identify the most important element, second most important, and clear groupings?
|
||||
- Is hierarchy achieved effectively? (Space and weight alone can be enough — but is the current approach working?)
|
||||
- Does whitespace guide the eye to what matters?
|
||||
|
||||
3. **Grid & structure**:
|
||||
- Is there a clear underlying structure, or does the layout feel random?
|
||||
- Are identical card grids used everywhere? (Icon + heading + text, repeated endlessly)
|
||||
- Is everything centered? (Left-aligned with asymmetric layouts feels more designed, but not a hard and fast rule)
|
||||
|
||||
4. **Rhythm & variety**:
|
||||
- Does the layout have visual rhythm? (Alternating tight/generous spacing)
|
||||
- Is every section structured the same way? (Monotonous repetition)
|
||||
- Are there intentional moments of surprise or emphasis?
|
||||
|
||||
5. **Density**:
|
||||
- Is the layout too cramped? (Not enough breathing room)
|
||||
- Is the layout too sparse? (Excessive whitespace without purpose)
|
||||
- Does density match the content type? (Data-dense UIs need tighter spacing; marketing pages need more air)
|
||||
|
||||
**CRITICAL**: Layout problems are often the root cause of interfaces feeling "off" even when colors and fonts are fine. Space is a design material — use it with intention.
|
||||
|
||||
## Plan Layout Improvements
|
||||
|
||||
Consult the [spatial design reference](reference/spatial-design.md) from the impeccable skill for detailed guidance on grids, rhythm, and container queries.
|
||||
|
||||
Create a systematic plan:
|
||||
|
||||
- **Spacing system**: Use a consistent scale — whether that's a framework's built-in scale (e.g., Tailwind), rem-based tokens, or a custom system. The specific values matter less than consistency.
|
||||
- **Hierarchy strategy**: How will space communicate importance?
|
||||
- **Layout approach**: What structure fits the content? Flex for 1D, Grid for 2D, named areas for complex page layouts.
|
||||
- **Rhythm**: Where should spacing be tight vs generous?
|
||||
|
||||
## Improve Layout Systematically
|
||||
|
||||
### Establish a Spacing System
|
||||
|
||||
- Use a consistent spacing scale — framework scales (Tailwind, etc.), rem-based tokens, or a custom scale all work. What matters is that values come from a defined set, not arbitrary numbers.
|
||||
- Name tokens semantically if using custom properties: `--space-xs` through `--space-xl`, not `--spacing-8`
|
||||
- Use `gap` for sibling spacing instead of margins — eliminates margin collapse hacks
|
||||
- Apply `clamp()` for fluid spacing that breathes on larger screens
|
||||
|
||||
### Create Visual Rhythm
|
||||
|
||||
- **Tight grouping** for related elements (8-12px between siblings)
|
||||
- **Generous separation** between distinct sections (48-96px)
|
||||
- **Varied spacing** within sections — not every row needs the same gap
|
||||
- **Asymmetric compositions** — break the predictable centered-content pattern when it makes sense
|
||||
|
||||
### Choose the Right Layout Tool
|
||||
|
||||
- **Use Flexbox for 1D layouts**: Rows of items, nav bars, button groups, card contents, most component internals. Flex is simpler and more appropriate for the majority of layout tasks.
|
||||
- **Use Grid for 2D layouts**: Page-level structure, dashboards, data-dense interfaces, anything where rows AND columns need coordinated control.
|
||||
- **Don't default to Grid** when Flexbox with `flex-wrap` would be simpler and more flexible.
|
||||
- Use `repeat(auto-fit, minmax(280px, 1fr))` for responsive grids without breakpoints.
|
||||
- Use named grid areas (`grid-template-areas`) for complex page layouts — redefine at breakpoints.
|
||||
|
||||
### Break Card Grid Monotony
|
||||
|
||||
- Don't default to card grids for everything — spacing and alignment create visual grouping naturally
|
||||
- Use cards only when content is truly distinct and actionable — never nest cards inside cards
|
||||
- Vary card sizes, span columns, or mix cards with non-card content to break repetition
|
||||
|
||||
### Strengthen Visual Hierarchy
|
||||
|
||||
- Use the fewest dimensions needed for clear hierarchy. Space alone can be enough — generous whitespace around an element draws the eye. Some of the most sophisticated designs achieve rhythm with just space and weight. Add color or size contrast only when simpler means aren't sufficient.
|
||||
- Be aware of reading flow — in LTR languages, the eye naturally scans top-left to bottom-right, but primary action placement depends on context (e.g., bottom-right in dialogs, top in navigation).
|
||||
- Create clear content groupings through proximity and separation.
|
||||
|
||||
### Manage Depth & Elevation
|
||||
|
||||
- Create a semantic z-index scale (dropdown → sticky → modal-backdrop → modal → toast → tooltip)
|
||||
- Build a consistent shadow scale (sm → md → lg → xl) — shadows should be subtle
|
||||
- Use elevation to reinforce hierarchy, not as decoration
|
||||
|
||||
### Optical Adjustments
|
||||
|
||||
- If an icon looks visually off-center despite being geometrically centered, nudge it — but only if you're confident it actually looks wrong. Don't adjust speculatively.
|
||||
|
||||
**NEVER**:
|
||||
- Use arbitrary spacing values outside your scale
|
||||
- Make all spacing equal — variety creates hierarchy
|
||||
- Wrap everything in cards — not everything needs a container
|
||||
- Nest cards inside cards — use spacing and dividers for hierarchy within
|
||||
- Use identical card grids everywhere (icon + heading + text, repeated)
|
||||
- Center everything — left-aligned with asymmetry feels more designed
|
||||
- Default to the hero metric layout (big number, small label, stats, gradient) as a template. If showing real user data, a prominent metric can work — but it should display actual data, not decorative numbers.
|
||||
- Default to CSS Grid when Flexbox would be simpler — use the simplest tool for the job
|
||||
- Use arbitrary z-index values (999, 9999) — build a semantic scale
|
||||
|
||||
## Verify Layout Improvements
|
||||
|
||||
- **Squint test**: Can you identify primary, secondary, and groupings with blurred vision?
|
||||
- **Rhythm**: Does the page have a satisfying beat of tight and generous spacing?
|
||||
- **Hierarchy**: Is the most important content obvious within 2 seconds?
|
||||
- **Breathing room**: Does the layout feel comfortable, not cramped or wasteful?
|
||||
- **Consistency**: Is the spacing system applied uniformly?
|
||||
- **Responsiveness**: Does the layout adapt gracefully across screen sizes?
|
||||
|
||||
Remember: Space is the most underused design tool. A layout with the right rhythm and hierarchy can make even simple content feel polished and intentional.
|
||||
If `{{command_prefix}}layout` is not available, tell the user to update their skills by running `npx impeccable skills update` in their terminal.
|
||||
|
||||
@@ -1,92 +1,8 @@
|
||||
---
|
||||
name: extract
|
||||
description: "Extract and consolidate reusable components, design tokens, and patterns into your design system. Identifies opportunities for systematic reuse and enriches your component library. Use when the user asks to create components, refactor repeated UI patterns, build a design system, or extract tokens."
|
||||
argument-hint: "[target]"
|
||||
user-invocable: true
|
||||
description: "DEPRECATED: This skill has been folded into 'impeccable extract'. Run /impeccable extract instead."
|
||||
---
|
||||
|
||||
Identify reusable patterns, components, and design tokens, then extract and consolidate them into the design system for systematic reuse.
|
||||
|
||||
## Discover
|
||||
|
||||
Analyze the target area to identify extraction opportunities:
|
||||
|
||||
1. **Find the design system**: Locate your design system, component library, or shared UI directory (grep for "design system", "ui", "components", etc.). Understand its structure:
|
||||
- Component organization and naming conventions
|
||||
- Design token structure (if any)
|
||||
- Documentation patterns
|
||||
- Import/export conventions
|
||||
|
||||
**CRITICAL**: If no design system exists, ask before creating one. Understand the preferred location and structure first.
|
||||
|
||||
2. **Identify patterns**: Look for:
|
||||
- **Repeated components**: Similar UI patterns used multiple times (buttons, cards, inputs, etc.)
|
||||
- **Hard-coded values**: Colors, spacing, typography, shadows that should be tokens
|
||||
- **Inconsistent variations**: Multiple implementations of the same concept (3 different button styles)
|
||||
- **Reusable patterns**: Layout patterns, composition patterns, interaction patterns worth systematizing
|
||||
|
||||
3. **Assess value**: Not everything should be extracted. Consider:
|
||||
- Is this used 3+ times, or likely to be reused?
|
||||
- Would systematizing this improve consistency?
|
||||
- Is this a general pattern or context-specific?
|
||||
- What's the maintenance cost vs benefit?
|
||||
|
||||
## Plan Extraction
|
||||
|
||||
Create a systematic extraction plan:
|
||||
|
||||
- **Components to extract**: Which UI elements become reusable components?
|
||||
- **Tokens to create**: Which hard-coded values become design tokens?
|
||||
- **Variants to support**: What variations does each component need?
|
||||
- **Naming conventions**: Component names, token names, prop names that match existing patterns
|
||||
- **Migration path**: How to refactor existing uses to consume the new shared versions
|
||||
|
||||
**IMPORTANT**: Design systems grow incrementally. Extract what's clearly reusable now, not everything that might someday be reusable.
|
||||
|
||||
## Extract & Enrich
|
||||
|
||||
Build improved, reusable versions:
|
||||
|
||||
- **Components**: Create well-designed components with:
|
||||
- Clear props API with sensible defaults
|
||||
- Proper variants for different use cases
|
||||
- Accessibility built in (ARIA, keyboard navigation, focus management)
|
||||
- Documentation and usage examples
|
||||
|
||||
- **Design tokens**: Create tokens with:
|
||||
- Clear naming (primitive vs semantic)
|
||||
- Proper hierarchy and organization
|
||||
- Documentation of when to use each token
|
||||
|
||||
- **Patterns**: Document patterns with:
|
||||
- When to use this pattern
|
||||
- Code examples
|
||||
- Variations and combinations
|
||||
|
||||
**NEVER**:
|
||||
- Extract one-off, context-specific implementations without generalization
|
||||
- Create components so generic they're useless
|
||||
- Extract without considering existing design system conventions
|
||||
- Skip proper TypeScript types or prop documentation
|
||||
- Create tokens for every single value (tokens should have semantic meaning)
|
||||
|
||||
## Migrate
|
||||
|
||||
Replace existing uses with the new shared versions:
|
||||
|
||||
- **Find all instances**: Search for the patterns you've extracted
|
||||
- **Replace systematically**: Update each use to consume the shared version
|
||||
- **Test thoroughly**: Ensure visual and functional parity
|
||||
- **Delete dead code**: Remove the old implementations
|
||||
|
||||
## Document
|
||||
|
||||
Update design system documentation:
|
||||
|
||||
- Add new components to the component library
|
||||
- Document token usage and values
|
||||
- Add examples and guidelines
|
||||
- Update any Storybook or component catalog
|
||||
|
||||
Remember: A good design system is a living system. Extract patterns as they emerge, enrich them thoughtfully, and maintain them consistently.
|
||||
This skill has been folded into **impeccable extract**. Run `{{command_prefix}}impeccable extract` instead.
|
||||
|
||||
If `{{command_prefix}}impeccable extract` is not available, tell the user to update their skills by running `npx impeccable skills update` in their terminal.
|
||||
|
||||
@@ -1,70 +1,8 @@
|
||||
---
|
||||
name: normalize
|
||||
description: "Audits and realigns UI to match design system standards, spacing, tokens, and patterns. Use when the user mentions consistency, design drift, mismatched styles, tokens, or wants to bring a feature back in line with the system."
|
||||
argument-hint: "[feature (page, route, component...)]"
|
||||
user-invocable: true
|
||||
description: "DEPRECATED: This skill has been merged into 'polish'. Run /polish instead."
|
||||
---
|
||||
|
||||
Analyze and redesign the feature to perfectly match our design system standards, aesthetics, and established patterns.
|
||||
This skill has been merged into **polish**. Run `{{command_prefix}}polish` instead. Polish now includes design system discovery and alignment as part of its workflow.
|
||||
|
||||
## MANDATORY PREPARATION
|
||||
|
||||
Invoke {{command_prefix}}impeccable — it contains design principles, anti-patterns, and the **Context Gathering Protocol**. Follow the protocol before proceeding — if no design context exists yet, you MUST run {{command_prefix}}impeccable teach first.
|
||||
|
||||
---
|
||||
|
||||
## Plan
|
||||
|
||||
Before making changes, deeply understand the context:
|
||||
|
||||
1. **Discover the design system**: Search for design system documentation, UI guidelines, component libraries, or style guides (grep for "design system", "ui guide", "style guide", etc.). Study it thoroughly until you understand:
|
||||
- Core design principles and aesthetic direction
|
||||
- Target audience and personas
|
||||
- Component patterns and conventions
|
||||
- Design tokens (colors, typography, spacing)
|
||||
|
||||
**CRITICAL**: If something isn't clear, ask. Don't guess at design system principles.
|
||||
|
||||
2. **Analyze the current feature**: Assess what works and what doesn't:
|
||||
- Where does it deviate from design system patterns?
|
||||
- Which inconsistencies are cosmetic vs. functional?
|
||||
- What's the root cause—missing tokens, one-off implementations, or conceptual misalignment?
|
||||
|
||||
3. **Create a normalization plan**: Define specific changes that will align the feature with the design system:
|
||||
- Which components can be replaced with design system equivalents?
|
||||
- Which styles need to use design tokens instead of hard-coded values?
|
||||
- How can UX patterns match established user flows?
|
||||
|
||||
**IMPORTANT**: Great design is effective design. Prioritize UX consistency and usability over visual polish alone. Think through the best possible experience for your use case and personas first.
|
||||
|
||||
## Execute
|
||||
|
||||
Systematically address all inconsistencies across these dimensions:
|
||||
|
||||
- **Typography**: Use design system fonts, sizes, weights, and line heights. Replace hard-coded values with typographic tokens or classes.
|
||||
- **Color & Theme**: Apply design system color tokens. Remove one-off color choices that break the palette.
|
||||
- **Spacing & Layout**: Use spacing tokens (margins, padding, gaps). Align with grid systems and layout patterns used elsewhere.
|
||||
- **Components**: Replace custom implementations with design system components. Ensure props and variants match established patterns.
|
||||
- **Motion & Interaction**: Match animation timing, easing, and interaction patterns to other features.
|
||||
- **Responsive Behavior**: Ensure breakpoints and responsive patterns align with design system standards.
|
||||
- **Accessibility**: Verify contrast ratios, focus states, ARIA labels match design system requirements.
|
||||
- **Progressive Disclosure**: Match information hierarchy and complexity management to established patterns.
|
||||
|
||||
**NEVER**:
|
||||
- Create new one-off components when design system equivalents exist
|
||||
- Hard-code values that should use design tokens
|
||||
- Introduce new patterns that diverge from the design system
|
||||
- Compromise accessibility for visual consistency
|
||||
|
||||
This is not an exhaustive list—apply judgment to identify all areas needing normalization.
|
||||
|
||||
## Clean Up
|
||||
|
||||
After normalization, ensure code quality:
|
||||
|
||||
- **Consolidate reusable components**: If you created new components that should be shared, move them to the design system or shared UI component path.
|
||||
- **Remove orphaned code**: Delete unused implementations, styles, or files made obsolete by normalization.
|
||||
- **Verify quality**: Lint, type-check, and test according to repository guidelines. Ensure normalization didn't introduce regressions.
|
||||
- **Ensure DRYness**: Look for duplication introduced during refactoring and consolidate.
|
||||
|
||||
Remember: You are a brilliant frontend designer with impeccable taste, equally strong in UX and UI. Your attention to detail and eye for end-to-end user experience is world class. Execute with precision and thoroughness.
|
||||
If `{{command_prefix}}polish` is not available, tell the user to update their skills by running `npx impeccable skills update` in their terminal.
|
||||
|
||||
@@ -1,246 +1,8 @@
|
||||
---
|
||||
name: onboard
|
||||
description: "Designs and improves onboarding flows, empty states, and first-run experiences to help users reach value quickly. Use when the user mentions onboarding, first-time users, empty states, activation, getting started, or new user flows."
|
||||
argument-hint: "[target]"
|
||||
user-invocable: true
|
||||
description: "DEPRECATED: This skill has been merged into 'harden'. Run /harden instead."
|
||||
---
|
||||
|
||||
## MANDATORY PREPARATION
|
||||
|
||||
Invoke {{command_prefix}}impeccable — it contains design principles, anti-patterns, and the **Context Gathering Protocol**. Follow the protocol before proceeding — if no design context exists yet, you MUST run {{command_prefix}}impeccable teach first. Additionally gather: the "aha moment" you want users to reach, and users' experience level.
|
||||
|
||||
---
|
||||
|
||||
Create or improve onboarding experiences that help users understand, adopt, and succeed with the product quickly.
|
||||
|
||||
## Assess Onboarding Needs
|
||||
|
||||
Understand what users need to learn and why:
|
||||
|
||||
1. **Identify the challenge**:
|
||||
- What are users trying to accomplish?
|
||||
- What's confusing or unclear about current experience?
|
||||
- Where do users get stuck or drop off?
|
||||
- What's the "aha moment" we want users to reach?
|
||||
|
||||
2. **Understand the users**:
|
||||
- What's their experience level? (Beginners, power users, mixed?)
|
||||
- What's their motivation? (Excited and exploring? Required by work?)
|
||||
- What's their time commitment? (5 minutes? 30 minutes?)
|
||||
- What alternatives do they know? (Coming from competitor? New to category?)
|
||||
|
||||
3. **Define success**:
|
||||
- What's the minimum users need to learn to be successful?
|
||||
- What's the key action we want them to take? (First project? First invite?)
|
||||
- How do we know onboarding worked? (Completion rate? Time to value?)
|
||||
|
||||
**CRITICAL**: Onboarding should get users to value as quickly as possible, not teach everything possible.
|
||||
|
||||
## Onboarding Principles
|
||||
|
||||
Follow these core principles:
|
||||
|
||||
### Show, Don't Tell
|
||||
- Demonstrate with working examples, not just descriptions
|
||||
- Provide real functionality in onboarding, not separate tutorial mode
|
||||
- Use progressive disclosure - teach one thing at a time
|
||||
|
||||
### Make It Optional (When Possible)
|
||||
- Let experienced users skip onboarding
|
||||
- Don't block access to product
|
||||
- Provide "Skip" or "I'll explore on my own" options
|
||||
|
||||
### Time to Value
|
||||
- Get users to their "aha moment" ASAP
|
||||
- Front-load most important concepts
|
||||
- Teach 20% that delivers 80% of value
|
||||
- Save advanced features for contextual discovery
|
||||
|
||||
### Context Over Ceremony
|
||||
- Teach features when users need them, not upfront
|
||||
- Empty states are onboarding opportunities
|
||||
- Tooltips and hints at point of use
|
||||
|
||||
### Respect User Intelligence
|
||||
- Don't patronize or over-explain
|
||||
- Be concise and clear
|
||||
- Assume users can figure out standard patterns
|
||||
|
||||
## Design Onboarding Experiences
|
||||
|
||||
Create appropriate onboarding for the context:
|
||||
|
||||
### Initial Product Onboarding
|
||||
|
||||
**Welcome Screen**:
|
||||
- Clear value proposition (what is this product?)
|
||||
- What users will learn/accomplish
|
||||
- Time estimate (honest about commitment)
|
||||
- Option to skip (for experienced users)
|
||||
|
||||
**Account Setup**:
|
||||
- Minimal required information (collect more later)
|
||||
- Explain why you're asking for each piece of information
|
||||
- Smart defaults where possible
|
||||
- Social login when appropriate
|
||||
|
||||
**Core Concept Introduction**:
|
||||
- Introduce 1-3 core concepts (not everything)
|
||||
- Use simple language and examples
|
||||
- Interactive when possible (do, don't just read)
|
||||
- Progress indication (step 1 of 3)
|
||||
|
||||
**First Success**:
|
||||
- Guide users to accomplish something real
|
||||
- Pre-populated examples or templates
|
||||
- Celebrate completion (but don't overdo it)
|
||||
- Clear next steps
|
||||
|
||||
### Feature Discovery & Adoption
|
||||
|
||||
**Empty States**:
|
||||
Instead of blank space, show:
|
||||
- What will appear here (description + screenshot/illustration)
|
||||
- Why it's valuable
|
||||
- Clear CTA to create first item
|
||||
- Example or template option
|
||||
|
||||
Example:
|
||||
```
|
||||
No projects yet
|
||||
Projects help you organize your work and collaborate with your team.
|
||||
[Create your first project] or [Start from template]
|
||||
```
|
||||
|
||||
**Contextual Tooltips**:
|
||||
- Appear at relevant moment (first time user sees feature)
|
||||
- Point directly at relevant UI element
|
||||
- Brief explanation + benefit
|
||||
- Dismissable (with "Don't show again" option)
|
||||
- Optional "Learn more" link
|
||||
|
||||
**Feature Announcements**:
|
||||
- Highlight new features when they're released
|
||||
- Show what's new and why it matters
|
||||
- Let users try immediately
|
||||
- Dismissable
|
||||
|
||||
**Progressive Onboarding**:
|
||||
- Teach features when users encounter them
|
||||
- Badges or indicators on new/unused features
|
||||
- Unlock complexity gradually (don't show all options immediately)
|
||||
|
||||
### Guided Tours & Walkthroughs
|
||||
|
||||
**When to use**:
|
||||
- Complex interfaces with many features
|
||||
- Significant changes to existing product
|
||||
- Industry-specific tools needing domain knowledge
|
||||
|
||||
**How to design**:
|
||||
- Spotlight specific UI elements (dim rest of page)
|
||||
- Keep steps short (3-7 steps max per tour)
|
||||
- Allow users to click through tour freely
|
||||
- Include "Skip tour" option
|
||||
- Make replayable (help menu)
|
||||
|
||||
**Best practices**:
|
||||
- Interactive > passive (let users click real buttons)
|
||||
- Focus on workflow, not features ("Create a project" not "This is the project button")
|
||||
- Provide sample data so actions work
|
||||
|
||||
### Interactive Tutorials
|
||||
|
||||
**When to use**:
|
||||
- Users need hands-on practice
|
||||
- Concepts are complex or unfamiliar
|
||||
- High stakes (better to practice in safe environment)
|
||||
|
||||
**How to design**:
|
||||
- Sandbox environment with sample data
|
||||
- Clear objectives ("Create a chart showing sales by region")
|
||||
- Step-by-step guidance
|
||||
- Validation (confirm they did it right)
|
||||
- Graduation moment (you're ready!)
|
||||
|
||||
### Documentation & Help
|
||||
|
||||
**In-product help**:
|
||||
- Contextual help links throughout interface
|
||||
- Keyboard shortcut reference
|
||||
- Search-able help center
|
||||
- Video tutorials for complex workflows
|
||||
|
||||
**Help patterns**:
|
||||
- `?` icon near complex features
|
||||
- "Learn more" links in tooltips
|
||||
- Keyboard shortcut hints (`⌘K` shown on search box)
|
||||
|
||||
## Empty State Design
|
||||
|
||||
Every empty state needs:
|
||||
|
||||
### What Will Be Here
|
||||
"Your recent projects will appear here"
|
||||
|
||||
### Why It Matters
|
||||
"Projects help you organize your work and collaborate with your team"
|
||||
|
||||
### How to Get Started
|
||||
[Create project] or [Import from template]
|
||||
|
||||
### Visual Interest
|
||||
Illustration or icon (not just text on blank page)
|
||||
|
||||
### Contextual Help
|
||||
"Need help getting started? [Watch 2-min tutorial]"
|
||||
|
||||
**Empty state types**:
|
||||
- **First use**: Never used this feature (emphasize value, provide template)
|
||||
- **User cleared**: Intentionally deleted everything (light touch, easy to recreate)
|
||||
- **No results**: Search or filter returned nothing (suggest different query, clear filters)
|
||||
- **No permissions**: Can't access (explain why, how to get access)
|
||||
- **Error state**: Failed to load (explain what happened, retry option)
|
||||
|
||||
## Implementation Patterns
|
||||
|
||||
### Technical approaches:
|
||||
|
||||
**Tooltip libraries**: Tippy.js, Popper.js
|
||||
**Tour libraries**: Intro.js, Shepherd.js, React Joyride
|
||||
**Modal patterns**: Focus trap, backdrop, ESC to close
|
||||
**Progress tracking**: LocalStorage for "seen" states
|
||||
**Analytics**: Track completion, drop-off points
|
||||
|
||||
**Storage patterns**:
|
||||
```javascript
|
||||
// Track which onboarding steps user has seen
|
||||
localStorage.setItem('onboarding-completed', 'true');
|
||||
localStorage.setItem('feature-tooltip-seen-reports', 'true');
|
||||
```
|
||||
|
||||
**IMPORTANT**: Don't show same onboarding twice (annoying). Track completion and respect dismissals.
|
||||
|
||||
**NEVER**:
|
||||
- Force users through long onboarding before they can use product
|
||||
- Patronize users with obvious explanations
|
||||
- Show same tooltip repeatedly (respect dismissals)
|
||||
- Block all UI during tour (let users explore)
|
||||
- Create separate tutorial mode disconnected from real product
|
||||
- Overwhelm with information upfront (progressive disclosure!)
|
||||
- Hide "Skip" or make it hard to find
|
||||
- Forget about returning users (don't show initial onboarding again)
|
||||
|
||||
## Verify Onboarding Quality
|
||||
|
||||
Test with real users:
|
||||
|
||||
- **Time to completion**: Can users complete onboarding quickly?
|
||||
- **Comprehension**: Do users understand after completing?
|
||||
- **Action**: Do users take desired next step?
|
||||
- **Skip rate**: Are too many users skipping? (Maybe it's too long/not valuable)
|
||||
- **Completion rate**: Are users completing? (If low, simplify)
|
||||
- **Time to value**: How long until users get first value?
|
||||
|
||||
Remember: You're a product educator with excellent teaching instincts. Get users to their "aha moment" as quickly as possible. Teach the essential, make it contextual, respect user time and intelligence.
|
||||
This skill has been merged into **harden**. Run `{{command_prefix}}harden` instead. Harden now covers onboarding flows, empty states, and first-run experiences as part of production readiness.
|
||||
|
||||
If `{{command_prefix}}harden` is not available, tell the user to update their skills by running `npx impeccable skills update` in their terminal.
|
||||
|
||||
Reference in New Issue
Block a user