@bastani/atomic 0.5.15 → 0.5.16-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.
@@ -1,107 +0,0 @@
1
- # UX Writing
2
-
3
- ## The Button Label Problem
4
-
5
- **Never use "OK", "Submit", or "Yes/No".** These are lazy and ambiguous. Use specific verb + object patterns:
6
-
7
- | Bad | Good | Why |
8
- |-----|------|-----|
9
- | OK | Save changes | Says what will happen |
10
- | Submit | Create account | Outcome-focused |
11
- | Yes | Delete message | Confirms the action |
12
- | Cancel | Keep editing | Clarifies what "cancel" means |
13
- | Click here | Download PDF | Describes the destination |
14
-
15
- **For destructive actions**, name the destruction:
16
- - "Delete" not "Remove" (delete is permanent, remove implies recoverable)
17
- - "Delete 5 items" not "Delete selected" (show the count)
18
-
19
- ## Error Messages: The Formula
20
-
21
- Every error message should answer: (1) What happened? (2) Why? (3) How to fix it? Example: "Email address isn't valid. Please include an @ symbol." not "Invalid input".
22
-
23
- ### Error Message Templates
24
-
25
- | Situation | Template |
26
- |-----------|----------|
27
- | **Format error** | "[Field] needs to be [format]. Example: [example]" |
28
- | **Missing required** | "Please enter [what's missing]" |
29
- | **Permission denied** | "You don't have access to [thing]. [What to do instead]" |
30
- | **Network error** | "We couldn't reach [thing]. Check your connection and [action]." |
31
- | **Server error** | "Something went wrong on our end. We're looking into it. [Alternative action]" |
32
-
33
- ### Don't Blame the User
34
-
35
- Reframe errors: "Please enter a date in MM/DD/YYYY format" not "You entered an invalid date".
36
-
37
- ## Empty States Are Opportunities
38
-
39
- Empty states are onboarding moments: (1) Acknowledge briefly, (2) Explain the value of filling it, (3) Provide a clear action. "No projects yet. Create your first one to get started." not just "No items".
40
-
41
- ## Voice vs Tone
42
-
43
- **Voice** is your brand's personality—consistent everywhere.
44
- **Tone** adapts to the moment.
45
-
46
- | Moment | Tone Shift |
47
- |--------|------------|
48
- | Success | Celebratory, brief: "Done! Your changes are live." |
49
- | Error | Empathetic, helpful: "That didn't work. Here's what to try..." |
50
- | Loading | Reassuring: "Saving your work..." |
51
- | Destructive confirm | Serious, clear: "Delete this project? This can't be undone." |
52
-
53
- **Never use humor for errors.** Users are already frustrated. Be helpful, not cute.
54
-
55
- ## Writing for Accessibility
56
-
57
- **Link text** must have standalone meaning—"View pricing plans" not "Click here". **Alt text** describes information, not the image—"Revenue increased 40% in Q4" not "Chart". Use `alt=""` for decorative images. **Icon buttons** need `aria-label` for screen reader context.
58
-
59
- ## Writing for Translation
60
-
61
- ### Plan for Expansion
62
-
63
- German text is ~30% longer than English. Allocate space:
64
-
65
- | Language | Expansion |
66
- |----------|-----------|
67
- | German | +30% |
68
- | French | +20% |
69
- | Finnish | +30-40% |
70
- | Chinese | -30% (fewer chars, but same width) |
71
-
72
- ### Translation-Friendly Patterns
73
-
74
- Keep numbers separate ("New messages: 3" not "You have 3 new messages"). Use full sentences as single strings (word order varies by language). Avoid abbreviations ("5 minutes ago" not "5 mins ago"). Give translators context about where strings appear.
75
-
76
- ## Consistency: The Terminology Problem
77
-
78
- Pick one term and stick with it:
79
-
80
- | Inconsistent | Consistent |
81
- |--------------|------------|
82
- | Delete / Remove / Trash | Delete |
83
- | Settings / Preferences / Options | Settings |
84
- | Sign in / Log in / Enter | Sign in |
85
- | Create / Add / New | Create |
86
-
87
- Build a terminology glossary and enforce it. Variety creates confusion.
88
-
89
- ## Avoid Redundant Copy
90
-
91
- If the heading explains it, the intro is redundant. If the button is clear, don't explain it again. Say it once, say it well.
92
-
93
- ## Loading States
94
-
95
- Be specific: "Saving your draft..." not "Loading...". For long waits, set expectations ("This usually takes 30 seconds") or show progress.
96
-
97
- ## Confirmation Dialogs: Use Sparingly
98
-
99
- Most confirmation dialogs are design failures—consider undo instead. When you must confirm: name the action, explain consequences, use specific button labels ("Delete project" / "Keep project", not "Yes" / "No").
100
-
101
- ## Form Instructions
102
-
103
- Show format with placeholders, not instructions. For non-obvious fields, explain why you're asking.
104
-
105
- ---
106
-
107
- **Avoid**: Jargon without explanation. Blaming users ("You made an error" → "This field is required"). Vague errors ("Something went wrong"). Varying terminology for variety. Humor for errors.
@@ -1,70 +0,0 @@
1
- ---
2
- name: normalize
3
- 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.
4
- user-invocable: true
5
- argument-hint: "[feature (page, route, component...)]"
6
- ---
7
-
8
- Analyze and redesign the feature to perfectly match our design system standards, aesthetics, and established patterns.
9
-
10
- ## MANDATORY PREPARATION
11
-
12
- Invoke /frontend-design — 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 /teach-impeccable first.
13
-
14
- ---
15
-
16
- ## Plan
17
-
18
- Before making changes, deeply understand the context:
19
-
20
- 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:
21
- - Core design principles and aesthetic direction
22
- - Target audience and personas
23
- - Component patterns and conventions
24
- - Design tokens (colors, typography, spacing)
25
-
26
- **CRITICAL**: If something isn't clear, ask. Don't guess at design system principles.
27
-
28
- 2. **Analyze the current feature**: Assess what works and what doesn't:
29
- - Where does it deviate from design system patterns?
30
- - Which inconsistencies are cosmetic vs. functional?
31
- - What's the root cause—missing tokens, one-off implementations, or conceptual misalignment?
32
-
33
- 3. **Create a normalization plan**: Define specific changes that will align the feature with the design system:
34
- - Which components can be replaced with design system equivalents?
35
- - Which styles need to use design tokens instead of hard-coded values?
36
- - How can UX patterns match established user flows?
37
-
38
- **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.
39
-
40
- ## Execute
41
-
42
- Systematically address all inconsistencies across these dimensions:
43
-
44
- - **Typography**: Use design system fonts, sizes, weights, and line heights. Replace hard-coded values with typographic tokens or classes.
45
- - **Color & Theme**: Apply design system color tokens. Remove one-off color choices that break the palette.
46
- - **Spacing & Layout**: Use spacing tokens (margins, padding, gaps). Align with grid systems and layout patterns used elsewhere.
47
- - **Components**: Replace custom implementations with design system components. Ensure props and variants match established patterns.
48
- - **Motion & Interaction**: Match animation timing, easing, and interaction patterns to other features.
49
- - **Responsive Behavior**: Ensure breakpoints and responsive patterns align with design system standards.
50
- - **Accessibility**: Verify contrast ratios, focus states, ARIA labels match design system requirements.
51
- - **Progressive Disclosure**: Match information hierarchy and complexity management to established patterns.
52
-
53
- **NEVER**:
54
- - Create new one-off components when design system equivalents exist
55
- - Hard-code values that should use design tokens
56
- - Introduce new patterns that diverge from the design system
57
- - Compromise accessibility for visual consistency
58
-
59
- This is not an exhaustive list—apply judgment to identify all areas needing normalization.
60
-
61
- ## Clean Up
62
-
63
- After normalization, ensure code quality:
64
-
65
- - **Consolidate reusable components**: If you created new components that should be shared, move them to the design system or shared UI component path.
66
- - **Remove orphaned code**: Delete unused implementations, styles, or files made obsolete by normalization.
67
- - **Verify quality**: Lint, type-check, and test according to repository guidelines. Ensure normalization didn't introduce regressions.
68
- - **Ensure DRYness**: Look for duplication introduced during refactoring and consolidate.
69
-
70
- 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.
@@ -1,245 +0,0 @@
1
- ---
2
- name: onboard
3
- 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.
4
- user-invocable: true
5
- argument-hint: "[target]"
6
- ---
7
-
8
- ## MANDATORY PREPARATION
9
-
10
- Invoke /frontend-design — 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 /teach-impeccable first. Additionally gather: the "aha moment" you want users to reach, and users' experience level.
11
-
12
- ---
13
-
14
- Create or improve onboarding experiences that help users understand, adopt, and succeed with the product quickly.
15
-
16
- ## Assess Onboarding Needs
17
-
18
- Understand what users need to learn and why:
19
-
20
- 1. **Identify the challenge**:
21
- - What are users trying to accomplish?
22
- - What's confusing or unclear about current experience?
23
- - Where do users get stuck or drop off?
24
- - What's the "aha moment" we want users to reach?
25
-
26
- 2. **Understand the users**:
27
- - What's their experience level? (Beginners, power users, mixed?)
28
- - What's their motivation? (Excited and exploring? Required by work?)
29
- - What's their time commitment? (5 minutes? 30 minutes?)
30
- - What alternatives do they know? (Coming from competitor? New to category?)
31
-
32
- 3. **Define success**:
33
- - What's the minimum users need to learn to be successful?
34
- - What's the key action we want them to take? (First project? First invite?)
35
- - How do we know onboarding worked? (Completion rate? Time to value?)
36
-
37
- **CRITICAL**: Onboarding should get users to value as quickly as possible, not teach everything possible.
38
-
39
- ## Onboarding Principles
40
-
41
- Follow these core principles:
42
-
43
- ### Show, Don't Tell
44
- - Demonstrate with working examples, not just descriptions
45
- - Provide real functionality in onboarding, not separate tutorial mode
46
- - Use progressive disclosure - teach one thing at a time
47
-
48
- ### Make It Optional (When Possible)
49
- - Let experienced users skip onboarding
50
- - Don't block access to product
51
- - Provide "Skip" or "I'll explore on my own" options
52
-
53
- ### Time to Value
54
- - Get users to their "aha moment" ASAP
55
- - Front-load most important concepts
56
- - Teach 20% that delivers 80% of value
57
- - Save advanced features for contextual discovery
58
-
59
- ### Context Over Ceremony
60
- - Teach features when users need them, not upfront
61
- - Empty states are onboarding opportunities
62
- - Tooltips and hints at point of use
63
-
64
- ### Respect User Intelligence
65
- - Don't patronize or over-explain
66
- - Be concise and clear
67
- - Assume users can figure out standard patterns
68
-
69
- ## Design Onboarding Experiences
70
-
71
- Create appropriate onboarding for the context:
72
-
73
- ### Initial Product Onboarding
74
-
75
- **Welcome Screen**:
76
- - Clear value proposition (what is this product?)
77
- - What users will learn/accomplish
78
- - Time estimate (honest about commitment)
79
- - Option to skip (for experienced users)
80
-
81
- **Account Setup**:
82
- - Minimal required information (collect more later)
83
- - Explain why you're asking for each piece of information
84
- - Smart defaults where possible
85
- - Social login when appropriate
86
-
87
- **Core Concept Introduction**:
88
- - Introduce 1-3 core concepts (not everything)
89
- - Use simple language and examples
90
- - Interactive when possible (do, don't just read)
91
- - Progress indication (step 1 of 3)
92
-
93
- **First Success**:
94
- - Guide users to accomplish something real
95
- - Pre-populated examples or templates
96
- - Celebrate completion (but don't overdo it)
97
- - Clear next steps
98
-
99
- ### Feature Discovery & Adoption
100
-
101
- **Empty States**:
102
- Instead of blank space, show:
103
- - What will appear here (description + screenshot/illustration)
104
- - Why it's valuable
105
- - Clear CTA to create first item
106
- - Example or template option
107
-
108
- Example:
109
- ```
110
- No projects yet
111
- Projects help you organize your work and collaborate with your team.
112
- [Create your first project] or [Start from template]
113
- ```
114
-
115
- **Contextual Tooltips**:
116
- - Appear at relevant moment (first time user sees feature)
117
- - Point directly at relevant UI element
118
- - Brief explanation + benefit
119
- - Dismissable (with "Don't show again" option)
120
- - Optional "Learn more" link
121
-
122
- **Feature Announcements**:
123
- - Highlight new features when they're released
124
- - Show what's new and why it matters
125
- - Let users try immediately
126
- - Dismissable
127
-
128
- **Progressive Onboarding**:
129
- - Teach features when users encounter them
130
- - Badges or indicators on new/unused features
131
- - Unlock complexity gradually (don't show all options immediately)
132
-
133
- ### Guided Tours & Walkthroughs
134
-
135
- **When to use**:
136
- - Complex interfaces with many features
137
- - Significant changes to existing product
138
- - Industry-specific tools needing domain knowledge
139
-
140
- **How to design**:
141
- - Spotlight specific UI elements (dim rest of page)
142
- - Keep steps short (3-7 steps max per tour)
143
- - Allow users to click through tour freely
144
- - Include "Skip tour" option
145
- - Make replayable (help menu)
146
-
147
- **Best practices**:
148
- - Interactive > passive (let users click real buttons)
149
- - Focus on workflow, not features ("Create a project" not "This is the project button")
150
- - Provide sample data so actions work
151
-
152
- ### Interactive Tutorials
153
-
154
- **When to use**:
155
- - Users need hands-on practice
156
- - Concepts are complex or unfamiliar
157
- - High stakes (better to practice in safe environment)
158
-
159
- **How to design**:
160
- - Sandbox environment with sample data
161
- - Clear objectives ("Create a chart showing sales by region")
162
- - Step-by-step guidance
163
- - Validation (confirm they did it right)
164
- - Graduation moment (you're ready!)
165
-
166
- ### Documentation & Help
167
-
168
- **In-product help**:
169
- - Contextual help links throughout interface
170
- - Keyboard shortcut reference
171
- - Search-able help center
172
- - Video tutorials for complex workflows
173
-
174
- **Help patterns**:
175
- - `?` icon near complex features
176
- - "Learn more" links in tooltips
177
- - Keyboard shortcut hints (`⌘K` shown on search box)
178
-
179
- ## Empty State Design
180
-
181
- Every empty state needs:
182
-
183
- ### What Will Be Here
184
- "Your recent projects will appear here"
185
-
186
- ### Why It Matters
187
- "Projects help you organize your work and collaborate with your team"
188
-
189
- ### How to Get Started
190
- [Create project] or [Import from template]
191
-
192
- ### Visual Interest
193
- Illustration or icon (not just text on blank page)
194
-
195
- ### Contextual Help
196
- "Need help getting started? [Watch 2-min tutorial]"
197
-
198
- **Empty state types**:
199
- - **First use**: Never used this feature (emphasize value, provide template)
200
- - **User cleared**: Intentionally deleted everything (light touch, easy to recreate)
201
- - **No results**: Search or filter returned nothing (suggest different query, clear filters)
202
- - **No permissions**: Can't access (explain why, how to get access)
203
- - **Error state**: Failed to load (explain what happened, retry option)
204
-
205
- ## Implementation Patterns
206
-
207
- ### Technical approaches:
208
-
209
- **Tooltip libraries**: Tippy.js, Popper.js
210
- **Tour libraries**: Intro.js, Shepherd.js, React Joyride
211
- **Modal patterns**: Focus trap, backdrop, ESC to close
212
- **Progress tracking**: LocalStorage for "seen" states
213
- **Analytics**: Track completion, drop-off points
214
-
215
- **Storage patterns**:
216
- ```javascript
217
- // Track which onboarding steps user has seen
218
- localStorage.setItem('onboarding-completed', 'true');
219
- localStorage.setItem('feature-tooltip-seen-reports', 'true');
220
- ```
221
-
222
- **IMPORTANT**: Don't show same onboarding twice (annoying). Track completion and respect dismissals.
223
-
224
- **NEVER**:
225
- - Force users through long onboarding before they can use product
226
- - Patronize users with obvious explanations
227
- - Show same tooltip repeatedly (respect dismissals)
228
- - Block all UI during tour (let users explore)
229
- - Create separate tutorial mode disconnected from real product
230
- - Overwhelm with information upfront (progressive disclosure!)
231
- - Hide "Skip" or make it hard to find
232
- - Forget about returning users (don't show initial onboarding again)
233
-
234
- ## Verify Onboarding Quality
235
-
236
- Test with real users:
237
-
238
- - **Time to completion**: Can users complete onboarding quickly?
239
- - **Comprehension**: Do users understand after completing?
240
- - **Action**: Do users take desired next step?
241
- - **Skip rate**: Are too many users skipping? (Maybe it's too long/not valuable)
242
- - **Completion rate**: Are users completing? (If low, simplify)
243
- - **Time to value**: How long until users get first value?
244
-
245
- 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.
@@ -1,71 +0,0 @@
1
- ---
2
- name: teach-impeccable
3
- description: One-time setup that gathers design context for your project and saves it to your AI config file. Run once to establish persistent design guidelines.
4
- user-invocable: true
5
- ---
6
-
7
- Gather design context for this project, then persist it for all future sessions.
8
-
9
- ## Step 1: Explore the Codebase
10
-
11
- Before asking questions, thoroughly scan the project to discover what you can:
12
-
13
- - **README and docs**: Project purpose, target audience, any stated goals
14
- - **Package.json / config files**: Tech stack, dependencies, existing design libraries
15
- - **Existing components**: Current design patterns, spacing, typography in use
16
- - **Brand assets**: Logos, favicons, color values already defined
17
- - **Design tokens / CSS variables**: Existing color palettes, font stacks, spacing scales
18
- - **Any style guides or brand documentation**
19
-
20
- Note what you've learned and what remains unclear.
21
-
22
- ## Step 2: Ask UX-Focused Questions
23
-
24
- ask the user directly to clarify what you cannot infer. Focus only on what you couldn't infer from the codebase:
25
-
26
- ### Users & Purpose
27
- - Who uses this? What's their context when using it?
28
- - What job are they trying to get done?
29
- - What emotions should the interface evoke? (confidence, delight, calm, urgency, etc.)
30
-
31
- ### Brand & Personality
32
- - How would you describe the brand personality in 3 words?
33
- - Any reference sites or apps that capture the right feel? What specifically about them?
34
- - What should this explicitly NOT look like? Any anti-references?
35
-
36
- ### Aesthetic Preferences
37
- - Any strong preferences for visual direction? (minimal, bold, elegant, playful, technical, organic, etc.)
38
- - Light mode, dark mode, or both?
39
- - Any colors that must be used or avoided?
40
-
41
- ### Accessibility & Inclusion
42
- - Specific accessibility requirements? (WCAG level, known user needs)
43
- - Considerations for reduced motion, color blindness, or other accommodations?
44
-
45
- Skip questions where the answer is already clear from the codebase exploration.
46
-
47
- ## Step 3: Write Design Context
48
-
49
- Synthesize your findings and the user's answers into a `## Design Context` section:
50
-
51
- ```markdown
52
- ## Design Context
53
-
54
- ### Users
55
- [Who they are, their context, the job to be done]
56
-
57
- ### Brand Personality
58
- [Voice, tone, 3-word personality, emotional goals]
59
-
60
- ### Aesthetic Direction
61
- [Visual tone, references, anti-references, theme]
62
-
63
- ### Design Principles
64
- [3-5 principles derived from the conversation that should guide all design decisions]
65
- ```
66
-
67
- Write this section to `.impeccable.md` in the project root. If the file already exists, update the Design Context section in place.
68
-
69
- Then ask the user directly to clarify what you cannot infer. whether they'd also like the Design Context appended to .github/copilot-instructions.md. If yes, append or update the section there as well.
70
-
71
- Confirm completion and summarize the key design principles that will now guide all future work.