@ia-ccun/code-agent-cli 0.0.47 → 0.0.49-beta.1

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.
Files changed (78) hide show
  1. package/config/agent/extensions/aicode-tips.ts +19 -0
  2. package/config/agent/skills/design-md/README.md +34 -0
  3. package/config/agent/skills/design-md/SKILL.md +172 -0
  4. package/config/agent/skills/design-md/examples/DESIGN.md +154 -0
  5. package/config/agent/skills/fireworks-tech-graph/LICENSE +21 -0
  6. package/config/agent/skills/fireworks-tech-graph/README.md +528 -0
  7. package/config/agent/skills/fireworks-tech-graph/README.zh.md +499 -0
  8. package/config/agent/skills/fireworks-tech-graph/SKILL.md +537 -0
  9. package/config/agent/skills/fireworks-tech-graph/agentloop-core.svg +101 -0
  10. package/config/agent/skills/fireworks-tech-graph/agents/openai.yaml +4 -0
  11. package/config/agent/skills/fireworks-tech-graph/assets/samples/sample-style1-flat.png +0 -0
  12. package/config/agent/skills/fireworks-tech-graph/assets/samples/sample-style2-dark.png +0 -0
  13. package/config/agent/skills/fireworks-tech-graph/assets/samples/sample-style3-blueprint.png +0 -0
  14. package/config/agent/skills/fireworks-tech-graph/assets/samples/sample-style4-notion.png +0 -0
  15. package/config/agent/skills/fireworks-tech-graph/assets/samples/sample-style5-glass.png +0 -0
  16. package/config/agent/skills/fireworks-tech-graph/assets/samples/sample-style6-claude.png +0 -0
  17. package/config/agent/skills/fireworks-tech-graph/assets/samples/sample-style7-openai.png +0 -0
  18. package/config/agent/skills/fireworks-tech-graph/fixtures/agent-memory-types-style4.json +181 -0
  19. package/config/agent/skills/fireworks-tech-graph/fixtures/api-flow-style7.json +40 -0
  20. package/config/agent/skills/fireworks-tech-graph/fixtures/mem0-style1.json +297 -0
  21. package/config/agent/skills/fireworks-tech-graph/fixtures/microservices-style3.json +64 -0
  22. package/config/agent/skills/fireworks-tech-graph/fixtures/multi-agent-style5.json +45 -0
  23. package/config/agent/skills/fireworks-tech-graph/fixtures/system-architecture-style6.json +48 -0
  24. package/config/agent/skills/fireworks-tech-graph/fixtures/tool-call-style2.json +182 -0
  25. package/config/agent/skills/fireworks-tech-graph/package.json +42 -0
  26. package/config/agent/skills/fireworks-tech-graph/references/icons.md +406 -0
  27. package/config/agent/skills/fireworks-tech-graph/references/style-1-flat-icon.md +108 -0
  28. package/config/agent/skills/fireworks-tech-graph/references/style-2-dark-terminal.md +107 -0
  29. package/config/agent/skills/fireworks-tech-graph/references/style-3-blueprint.md +113 -0
  30. package/config/agent/skills/fireworks-tech-graph/references/style-4-notion-clean.md +94 -0
  31. package/config/agent/skills/fireworks-tech-graph/references/style-5-glassmorphism.md +125 -0
  32. package/config/agent/skills/fireworks-tech-graph/references/style-6-claude-official.md +209 -0
  33. package/config/agent/skills/fireworks-tech-graph/references/style-7-openai.md +215 -0
  34. package/config/agent/skills/fireworks-tech-graph/references/style-diagram-matrix.md +135 -0
  35. package/config/agent/skills/fireworks-tech-graph/references/svg-layout-best-practices.md +100 -0
  36. package/config/agent/skills/fireworks-tech-graph/scripts/README.md +244 -0
  37. package/config/agent/skills/fireworks-tech-graph/scripts/generate-diagram.sh +157 -0
  38. package/config/agent/skills/fireworks-tech-graph/scripts/generate-from-template.py +1556 -0
  39. package/config/agent/skills/fireworks-tech-graph/scripts/test-all-styles.sh +135 -0
  40. package/config/agent/skills/fireworks-tech-graph/scripts/validate-svg.sh +292 -0
  41. package/config/agent/skills/fireworks-tech-graph/templates/agent-architecture.svg +28 -0
  42. package/config/agent/skills/fireworks-tech-graph/templates/architecture.svg +23 -0
  43. package/config/agent/skills/fireworks-tech-graph/templates/comparison-matrix.svg +14 -0
  44. package/config/agent/skills/fireworks-tech-graph/templates/data-flow.svg +28 -0
  45. package/config/agent/skills/fireworks-tech-graph/templates/er-diagram.svg +21 -0
  46. package/config/agent/skills/fireworks-tech-graph/templates/flowchart.svg +21 -0
  47. package/config/agent/skills/fireworks-tech-graph/templates/sequence.svg +20 -0
  48. package/config/agent/skills/fireworks-tech-graph/templates/state-machine.svg +20 -0
  49. package/config/agent/skills/fireworks-tech-graph/templates/timeline.svg +19 -0
  50. package/config/agent/skills/fireworks-tech-graph/templates/use-case.svg +21 -0
  51. package/config/agent/skills/impeccable/adapt/SKILL.md +205 -0
  52. package/config/agent/skills/impeccable/animate/SKILL.md +178 -0
  53. package/config/agent/skills/impeccable/arrange/SKILL.md +128 -0
  54. package/config/agent/skills/impeccable/audit/SKILL.md +129 -0
  55. package/config/agent/skills/impeccable/bolder/SKILL.md +120 -0
  56. package/config/agent/skills/impeccable/clarify/SKILL.md +186 -0
  57. package/config/agent/skills/impeccable/colorize/SKILL.md +146 -0
  58. package/config/agent/skills/impeccable/critique/SKILL.md +123 -0
  59. package/config/agent/skills/impeccable/delight/SKILL.md +307 -0
  60. package/config/agent/skills/impeccable/distill/SKILL.md +125 -0
  61. package/config/agent/skills/impeccable/extract/SKILL.md +95 -0
  62. package/config/agent/skills/impeccable/frontend-design/reference/color-and-contrast.md +132 -0
  63. package/config/agent/skills/impeccable/frontend-design/reference/interaction-design.md +123 -0
  64. package/config/agent/skills/impeccable/frontend-design/reference/motion-design.md +99 -0
  65. package/config/agent/skills/impeccable/frontend-design/reference/responsive-design.md +114 -0
  66. package/config/agent/skills/impeccable/frontend-design/reference/spatial-design.md +100 -0
  67. package/config/agent/skills/impeccable/frontend-design/reference/typography.md +133 -0
  68. package/config/agent/skills/impeccable/frontend-design/reference/ux-writing.md +107 -0
  69. package/config/agent/skills/impeccable/harden/SKILL.md +358 -0
  70. package/config/agent/skills/impeccable/normalize/SKILL.md +74 -0
  71. package/config/agent/skills/impeccable/onboard/SKILL.md +249 -0
  72. package/config/agent/skills/impeccable/optimize/SKILL.md +269 -0
  73. package/config/agent/skills/impeccable/overdrive/SKILL.md +145 -0
  74. package/config/agent/skills/impeccable/polish/SKILL.md +206 -0
  75. package/config/agent/skills/impeccable/quieter/SKILL.md +106 -0
  76. package/config/agent/skills/impeccable/teach-impeccable/SKILL.md +72 -0
  77. package/config/agent/skills/impeccable/typeset/SKILL.md +119 -0
  78. package/package.json +1 -1
@@ -0,0 +1,358 @@
1
+ ---
2
+ name: harden
3
+ description: 通过改进错误处理、i18n 支持、文字溢出处理和边界情况管理,提升界面的健壮性,使界面达到可上线标准。
4
+ disable-model-invocation: true
5
+ user-invocable: true
6
+ args:
7
+ - name: target
8
+ description: The feature or area to harden (optional)
9
+ required: false
10
+ ---
11
+
12
+ Strengthen interfaces against edge cases, errors, internationalization issues, and real-world usage scenarios that break idealized designs.
13
+
14
+ ## Assess Hardening Needs
15
+
16
+ Identify weaknesses and edge cases:
17
+
18
+ 1. **Test with extreme inputs**:
19
+ - Very long text (names, descriptions, titles)
20
+ - Very short text (empty, single character)
21
+ - Special characters (emoji, RTL text, accents)
22
+ - Large numbers (millions, billions)
23
+ - Many items (1000+ list items, 50+ options)
24
+ - No data (empty states)
25
+
26
+ 2. **Test error scenarios**:
27
+ - Network failures (offline, slow, timeout)
28
+ - API errors (400, 401, 403, 404, 500)
29
+ - Validation errors
30
+ - Permission errors
31
+ - Rate limiting
32
+ - Concurrent operations
33
+
34
+ 3. **Test internationalization**:
35
+ - Long translations (German is often 30% longer than English)
36
+ - RTL languages (Arabic, Hebrew)
37
+ - Character sets (Chinese, Japanese, Korean, emoji)
38
+ - Date/time formats
39
+ - Number formats (1,000 vs 1.000)
40
+ - Currency symbols
41
+
42
+ **CRITICAL**: Designs that only work with perfect data aren't production-ready. Harden against reality.
43
+
44
+ ## Hardening Dimensions
45
+
46
+ Systematically improve resilience:
47
+
48
+ ### Text Overflow & Wrapping
49
+
50
+ **Long text handling**:
51
+ ```css
52
+ /* Single line with ellipsis */
53
+ .truncate {
54
+ overflow: hidden;
55
+ text-overflow: ellipsis;
56
+ white-space: nowrap;
57
+ }
58
+
59
+ /* Multi-line with clamp */
60
+ .line-clamp {
61
+ display: -webkit-box;
62
+ -webkit-line-clamp: 3;
63
+ -webkit-box-orient: vertical;
64
+ overflow: hidden;
65
+ }
66
+
67
+ /* Allow wrapping */
68
+ .wrap {
69
+ word-wrap: break-word;
70
+ overflow-wrap: break-word;
71
+ hyphens: auto;
72
+ }
73
+ ```
74
+
75
+ **Flex/Grid overflow**:
76
+ ```css
77
+ /* Prevent flex items from overflowing */
78
+ .flex-item {
79
+ min-width: 0; /* Allow shrinking below content size */
80
+ overflow: hidden;
81
+ }
82
+
83
+ /* Prevent grid items from overflowing */
84
+ .grid-item {
85
+ min-width: 0;
86
+ min-height: 0;
87
+ }
88
+ ```
89
+
90
+ **Responsive text sizing**:
91
+ - Use `clamp()` for fluid typography
92
+ - Set minimum readable sizes (14px on mobile)
93
+ - Test text scaling (zoom to 200%)
94
+ - Ensure containers expand with text
95
+
96
+ ### Internationalization (i18n)
97
+
98
+ **Text expansion**:
99
+ - Add 30-40% space budget for translations
100
+ - Use flexbox/grid that adapts to content
101
+ - Test with longest language (usually German)
102
+ - Avoid fixed widths on text containers
103
+
104
+ ```jsx
105
+ // ❌ Bad: Assumes short English text
106
+ <button className="w-24">Submit</button>
107
+
108
+ // ✅ Good: Adapts to content
109
+ <button className="px-4 py-2">Submit</button>
110
+ ```
111
+
112
+ **RTL (Right-to-Left) support**:
113
+ ```css
114
+ /* Use logical properties */
115
+ margin-inline-start: 1rem; /* Not margin-left */
116
+ padding-inline: 1rem; /* Not padding-left/right */
117
+ border-inline-end: 1px solid; /* Not border-right */
118
+
119
+ /* Or use dir attribute */
120
+ [dir="rtl"] .arrow { transform: scaleX(-1); }
121
+ ```
122
+
123
+ **Character set support**:
124
+ - Use UTF-8 encoding everywhere
125
+ - Test with Chinese/Japanese/Korean (CJK) characters
126
+ - Test with emoji (they can be 2-4 bytes)
127
+ - Handle different scripts (Latin, Cyrillic, Arabic, etc.)
128
+
129
+ **Date/Time formatting**:
130
+ ```javascript
131
+ // ✅ Use Intl API for proper formatting
132
+ new Intl.DateTimeFormat('en-US').format(date); // 1/15/2024
133
+ new Intl.DateTimeFormat('de-DE').format(date); // 15.1.2024
134
+
135
+ new Intl.NumberFormat('en-US', {
136
+ style: 'currency',
137
+ currency: 'USD'
138
+ }).format(1234.56); // $1,234.56
139
+ ```
140
+
141
+ **Pluralization**:
142
+ ```javascript
143
+ // ❌ Bad: Assumes English pluralization
144
+ `${count} item${count !== 1 ? 's' : ''}`
145
+
146
+ // ✅ Good: Use proper i18n library
147
+ t('items', { count }) // Handles complex plural rules
148
+ ```
149
+
150
+ ### Error Handling
151
+
152
+ **Network errors**:
153
+ - Show clear error messages
154
+ - Provide retry button
155
+ - Explain what happened
156
+ - Offer offline mode (if applicable)
157
+ - Handle timeout scenarios
158
+
159
+ ```jsx
160
+ // Error states with recovery
161
+ {error && (
162
+ <ErrorMessage>
163
+ <p>Failed to load data. {error.message}</p>
164
+ <button onClick={retry}>Try again</button>
165
+ </ErrorMessage>
166
+ )}
167
+ ```
168
+
169
+ **Form validation errors**:
170
+ - Inline errors near fields
171
+ - Clear, specific messages
172
+ - Suggest corrections
173
+ - Don't block submission unnecessarily
174
+ - Preserve user input on error
175
+
176
+ **API errors**:
177
+ - Handle each status code appropriately
178
+ - 400: Show validation errors
179
+ - 401: Redirect to login
180
+ - 403: Show permission error
181
+ - 404: Show not found state
182
+ - 429: Show rate limit message
183
+ - 500: Show generic error, offer support
184
+
185
+ **Graceful degradation**:
186
+ - Core functionality works without JavaScript
187
+ - Images have alt text
188
+ - Progressive enhancement
189
+ - Fallbacks for unsupported features
190
+
191
+ ### Edge Cases & Boundary Conditions
192
+
193
+ **Empty states**:
194
+ - No items in list
195
+ - No search results
196
+ - No notifications
197
+ - No data to display
198
+ - Provide clear next action
199
+
200
+ **Loading states**:
201
+ - Initial load
202
+ - Pagination load
203
+ - Refresh
204
+ - Show what's loading ("Loading your projects...")
205
+ - Time estimates for long operations
206
+
207
+ **Large datasets**:
208
+ - Pagination or virtual scrolling
209
+ - Search/filter capabilities
210
+ - Performance optimization
211
+ - Don't load all 10,000 items at once
212
+
213
+ **Concurrent operations**:
214
+ - Prevent double-submission (disable button while loading)
215
+ - Handle race conditions
216
+ - Optimistic updates with rollback
217
+ - Conflict resolution
218
+
219
+ **Permission states**:
220
+ - No permission to view
221
+ - No permission to edit
222
+ - Read-only mode
223
+ - Clear explanation of why
224
+
225
+ **Browser compatibility**:
226
+ - Polyfills for modern features
227
+ - Fallbacks for unsupported CSS
228
+ - Feature detection (not browser detection)
229
+ - Test in target browsers
230
+
231
+ ### Input Validation & Sanitization
232
+
233
+ **Client-side validation**:
234
+ - Required fields
235
+ - Format validation (email, phone, URL)
236
+ - Length limits
237
+ - Pattern matching
238
+ - Custom validation rules
239
+
240
+ **Server-side validation** (always):
241
+ - Never trust client-side only
242
+ - Validate and sanitize all inputs
243
+ - Protect against injection attacks
244
+ - Rate limiting
245
+
246
+ **Constraint handling**:
247
+ ```html
248
+ <!-- Set clear constraints -->
249
+ <input
250
+ type="text"
251
+ maxlength="100"
252
+ pattern="[A-Za-z0-9]+"
253
+ required
254
+ aria-describedby="username-hint"
255
+ />
256
+ <small id="username-hint">
257
+ Letters and numbers only, up to 100 characters
258
+ </small>
259
+ ```
260
+
261
+ ### Accessibility Resilience
262
+
263
+ **Keyboard navigation**:
264
+ - All functionality accessible via keyboard
265
+ - Logical tab order
266
+ - Focus management in modals
267
+ - Skip links for long content
268
+
269
+ **Screen reader support**:
270
+ - Proper ARIA labels
271
+ - Announce dynamic changes (live regions)
272
+ - Descriptive alt text
273
+ - Semantic HTML
274
+
275
+ **Motion sensitivity**:
276
+ ```css
277
+ @media (prefers-reduced-motion: reduce) {
278
+ * {
279
+ animation-duration: 0.01ms !important;
280
+ animation-iteration-count: 1 !important;
281
+ transition-duration: 0.01ms !important;
282
+ }
283
+ }
284
+ ```
285
+
286
+ **High contrast mode**:
287
+ - Test in Windows high contrast mode
288
+ - Don't rely only on color
289
+ - Provide alternative visual cues
290
+
291
+ ### Performance Resilience
292
+
293
+ **Slow connections**:
294
+ - Progressive image loading
295
+ - Skeleton screens
296
+ - Optimistic UI updates
297
+ - Offline support (service workers)
298
+
299
+ **Memory leaks**:
300
+ - Clean up event listeners
301
+ - Cancel subscriptions
302
+ - Clear timers/intervals
303
+ - Abort pending requests on unmount
304
+
305
+ **Throttling & Debouncing**:
306
+ ```javascript
307
+ // Debounce search input
308
+ const debouncedSearch = debounce(handleSearch, 300);
309
+
310
+ // Throttle scroll handler
311
+ const throttledScroll = throttle(handleScroll, 100);
312
+ ```
313
+
314
+ ## Testing Strategies
315
+
316
+ **Manual testing**:
317
+ - Test with extreme data (very long, very short, empty)
318
+ - Test in different languages
319
+ - Test offline
320
+ - Test slow connection (throttle to 3G)
321
+ - Test with screen reader
322
+ - Test keyboard-only navigation
323
+ - Test on old browsers
324
+
325
+ **Automated testing**:
326
+ - Unit tests for edge cases
327
+ - Integration tests for error scenarios
328
+ - E2E tests for critical paths
329
+ - Visual regression tests
330
+ - Accessibility tests (axe, WAVE)
331
+
332
+ **IMPORTANT**: Hardening is about expecting the unexpected. Real users will do things you never imagined.
333
+
334
+ **NEVER**:
335
+ - Assume perfect input (validate everything)
336
+ - Ignore internationalization (design for global)
337
+ - Leave error messages generic ("Error occurred")
338
+ - Forget offline scenarios
339
+ - Trust client-side validation alone
340
+ - Use fixed widths for text
341
+ - Assume English-length text
342
+ - Block entire interface when one component errors
343
+
344
+ ## Verify Hardening
345
+
346
+ Test thoroughly with edge cases:
347
+
348
+ - **Long text**: Try names with 100+ characters
349
+ - **Emoji**: Use emoji in all text fields
350
+ - **RTL**: Test with Arabic or Hebrew
351
+ - **CJK**: Test with Chinese/Japanese/Korean
352
+ - **Network issues**: Disable internet, throttle connection
353
+ - **Large datasets**: Test with 1000+ items
354
+ - **Concurrent actions**: Click submit 10 times rapidly
355
+ - **Errors**: Force API errors, test all error states
356
+ - **Empty**: Remove all data, test empty states
357
+
358
+ Remember: You're hardening for production reality, not demo perfection. Expect users to input weird data, lose connection mid-flow, and use your product in unexpected ways. Build resilience into every component.
@@ -0,0 +1,74 @@
1
+ ---
2
+ name: normalize
3
+ description: 将设计规范与设计系统对齐,确保一致性。
4
+ disable-model-invocation: true
5
+ user-invocable: true
6
+ args:
7
+ - name: feature
8
+ description: The page, route, or feature to normalize (optional)
9
+ required: false
10
+ ---
11
+
12
+ Analyze and redesign the feature to perfectly match our design system standards, aesthetics, and established patterns.
13
+
14
+ ## MANDATORY PREPARATION
15
+
16
+ Use the frontend-design skill — 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.
17
+
18
+ ---
19
+
20
+ ## Plan
21
+
22
+ Before making changes, deeply understand the context:
23
+
24
+ 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:
25
+ - Core design principles and aesthetic direction
26
+ - Target audience and personas
27
+ - Component patterns and conventions
28
+ - Design tokens (colors, typography, spacing)
29
+
30
+ **CRITICAL**: If something isn't clear, ask. Don't guess at design system principles.
31
+
32
+ 2. **Analyze the current feature**: Assess what works and what doesn't:
33
+ - Where does it deviate from design system patterns?
34
+ - Which inconsistencies are cosmetic vs. functional?
35
+ - What's the root cause—missing tokens, one-off implementations, or conceptual misalignment?
36
+
37
+ 3. **Create a normalization plan**: Define specific changes that will align the feature with the design system:
38
+ - Which components can be replaced with design system equivalents?
39
+ - Which styles need to use design tokens instead of hard-coded values?
40
+ - How can UX patterns match established user flows?
41
+
42
+ **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.
43
+
44
+ ## Execute
45
+
46
+ Systematically address all inconsistencies across these dimensions:
47
+
48
+ - **Typography**: Use design system fonts, sizes, weights, and line heights. Replace hard-coded values with typographic tokens or classes.
49
+ - **Color & Theme**: Apply design system color tokens. Remove one-off color choices that break the palette.
50
+ - **Spacing & Layout**: Use spacing tokens (margins, padding, gaps). Align with grid systems and layout patterns used elsewhere.
51
+ - **Components**: Replace custom implementations with design system components. Ensure props and variants match established patterns.
52
+ - **Motion & Interaction**: Match animation timing, easing, and interaction patterns to other features.
53
+ - **Responsive Behavior**: Ensure breakpoints and responsive patterns align with design system standards.
54
+ - **Accessibility**: Verify contrast ratios, focus states, ARIA labels match design system requirements.
55
+ - **Progressive Disclosure**: Match information hierarchy and complexity management to established patterns.
56
+
57
+ **NEVER**:
58
+ - Create new one-off components when design system equivalents exist
59
+ - Hard-code values that should use design tokens
60
+ - Introduce new patterns that diverge from the design system
61
+ - Compromise accessibility for visual consistency
62
+
63
+ This is not an exhaustive list—apply judgment to identify all areas needing normalization.
64
+
65
+ ## Clean Up
66
+
67
+ After normalization, ensure code quality:
68
+
69
+ - **Consolidate reusable components**: If you created new components that should be shared, move them to the design system or shared UI component path.
70
+ - **Remove orphaned code**: Delete unused implementations, styles, or files made obsolete by normalization.
71
+ - **Verify quality**: Lint, type-check, and test according to repository guidelines. Ensure normalization didn't introduce regressions.
72
+ - **Ensure DRYness**: Look for duplication introduced during refactoring and consolidate.
73
+
74
+ 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.
@@ -0,0 +1,249 @@
1
+ ---
2
+ name: onboard
3
+ description: 设计或优化引导流程、空状态和首次用户体验,帮助用户顺利上手并快速理解产品价值。
4
+ disable-model-invocation: true
5
+ user-invocable: true
6
+ args:
7
+ - name: target
8
+ description: The feature or area needing onboarding (optional)
9
+ required: false
10
+ ---
11
+
12
+ ## MANDATORY PREPARATION
13
+
14
+ Use the frontend-design skill — 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.
15
+
16
+ ---
17
+
18
+ Create or improve onboarding experiences that help users understand, adopt, and succeed with the product quickly.
19
+
20
+ ## Assess Onboarding Needs
21
+
22
+ Understand what users need to learn and why:
23
+
24
+ 1. **Identify the challenge**:
25
+ - What are users trying to accomplish?
26
+ - What's confusing or unclear about current experience?
27
+ - Where do users get stuck or drop off?
28
+ - What's the "aha moment" we want users to reach?
29
+
30
+ 2. **Understand the users**:
31
+ - What's their experience level? (Beginners, power users, mixed?)
32
+ - What's their motivation? (Excited and exploring? Required by work?)
33
+ - What's their time commitment? (5 minutes? 30 minutes?)
34
+ - What alternatives do they know? (Coming from competitor? New to category?)
35
+
36
+ 3. **Define success**:
37
+ - What's the minimum users need to learn to be successful?
38
+ - What's the key action we want them to take? (First project? First invite?)
39
+ - How do we know onboarding worked? (Completion rate? Time to value?)
40
+
41
+ **CRITICAL**: Onboarding should get users to value as quickly as possible, not teach everything possible.
42
+
43
+ ## Onboarding Principles
44
+
45
+ Follow these core principles:
46
+
47
+ ### Show, Don't Tell
48
+ - Demonstrate with working examples, not just descriptions
49
+ - Provide real functionality in onboarding, not separate tutorial mode
50
+ - Use progressive disclosure - teach one thing at a time
51
+
52
+ ### Make It Optional (When Possible)
53
+ - Let experienced users skip onboarding
54
+ - Don't block access to product
55
+ - Provide "Skip" or "I'll explore on my own" options
56
+
57
+ ### Time to Value
58
+ - Get users to their "aha moment" ASAP
59
+ - Front-load most important concepts
60
+ - Teach 20% that delivers 80% of value
61
+ - Save advanced features for contextual discovery
62
+
63
+ ### Context Over Ceremony
64
+ - Teach features when users need them, not upfront
65
+ - Empty states are onboarding opportunities
66
+ - Tooltips and hints at point of use
67
+
68
+ ### Respect User Intelligence
69
+ - Don't patronize or over-explain
70
+ - Be concise and clear
71
+ - Assume users can figure out standard patterns
72
+
73
+ ## Design Onboarding Experiences
74
+
75
+ Create appropriate onboarding for the context:
76
+
77
+ ### Initial Product Onboarding
78
+
79
+ **Welcome Screen**:
80
+ - Clear value proposition (what is this product?)
81
+ - What users will learn/accomplish
82
+ - Time estimate (honest about commitment)
83
+ - Option to skip (for experienced users)
84
+
85
+ **Account Setup**:
86
+ - Minimal required information (collect more later)
87
+ - Explain why you're asking for each piece of information
88
+ - Smart defaults where possible
89
+ - Social login when appropriate
90
+
91
+ **Core Concept Introduction**:
92
+ - Introduce 1-3 core concepts (not everything)
93
+ - Use simple language and examples
94
+ - Interactive when possible (do, don't just read)
95
+ - Progress indication (step 1 of 3)
96
+
97
+ **First Success**:
98
+ - Guide users to accomplish something real
99
+ - Pre-populated examples or templates
100
+ - Celebrate completion (but don't overdo it)
101
+ - Clear next steps
102
+
103
+ ### Feature Discovery & Adoption
104
+
105
+ **Empty States**:
106
+ Instead of blank space, show:
107
+ - What will appear here (description + screenshot/illustration)
108
+ - Why it's valuable
109
+ - Clear CTA to create first item
110
+ - Example or template option
111
+
112
+ Example:
113
+ ```
114
+ No projects yet
115
+ Projects help you organize your work and collaborate with your team.
116
+ [Create your first project] or [Start from template]
117
+ ```
118
+
119
+ **Contextual Tooltips**:
120
+ - Appear at relevant moment (first time user sees feature)
121
+ - Point directly at relevant UI element
122
+ - Brief explanation + benefit
123
+ - Dismissable (with "Don't show again" option)
124
+ - Optional "Learn more" link
125
+
126
+ **Feature Announcements**:
127
+ - Highlight new features when they're released
128
+ - Show what's new and why it matters
129
+ - Let users try immediately
130
+ - Dismissable
131
+
132
+ **Progressive Onboarding**:
133
+ - Teach features when users encounter them
134
+ - Badges or indicators on new/unused features
135
+ - Unlock complexity gradually (don't show all options immediately)
136
+
137
+ ### Guided Tours & Walkthroughs
138
+
139
+ **When to use**:
140
+ - Complex interfaces with many features
141
+ - Significant changes to existing product
142
+ - Industry-specific tools needing domain knowledge
143
+
144
+ **How to design**:
145
+ - Spotlight specific UI elements (dim rest of page)
146
+ - Keep steps short (3-7 steps max per tour)
147
+ - Allow users to click through tour freely
148
+ - Include "Skip tour" option
149
+ - Make replayable (help menu)
150
+
151
+ **Best practices**:
152
+ - Interactive > passive (let users click real buttons)
153
+ - Focus on workflow, not features ("Create a project" not "This is the project button")
154
+ - Provide sample data so actions work
155
+
156
+ ### Interactive Tutorials
157
+
158
+ **When to use**:
159
+ - Users need hands-on practice
160
+ - Concepts are complex or unfamiliar
161
+ - High stakes (better to practice in safe environment)
162
+
163
+ **How to design**:
164
+ - Sandbox environment with sample data
165
+ - Clear objectives ("Create a chart showing sales by region")
166
+ - Step-by-step guidance
167
+ - Validation (confirm they did it right)
168
+ - Graduation moment (you're ready!)
169
+
170
+ ### Documentation & Help
171
+
172
+ **In-product help**:
173
+ - Contextual help links throughout interface
174
+ - Keyboard shortcut reference
175
+ - Search-able help center
176
+ - Video tutorials for complex workflows
177
+
178
+ **Help patterns**:
179
+ - `?` icon near complex features
180
+ - "Learn more" links in tooltips
181
+ - Keyboard shortcut hints (`⌘K` shown on search box)
182
+
183
+ ## Empty State Design
184
+
185
+ Every empty state needs:
186
+
187
+ ### What Will Be Here
188
+ "Your recent projects will appear here"
189
+
190
+ ### Why It Matters
191
+ "Projects help you organize your work and collaborate with your team"
192
+
193
+ ### How to Get Started
194
+ [Create project] or [Import from template]
195
+
196
+ ### Visual Interest
197
+ Illustration or icon (not just text on blank page)
198
+
199
+ ### Contextual Help
200
+ "Need help getting started? [Watch 2-min tutorial]"
201
+
202
+ **Empty state types**:
203
+ - **First use**: Never used this feature (emphasize value, provide template)
204
+ - **User cleared**: Intentionally deleted everything (light touch, easy to recreate)
205
+ - **No results**: Search or filter returned nothing (suggest different query, clear filters)
206
+ - **No permissions**: Can't access (explain why, how to get access)
207
+ - **Error state**: Failed to load (explain what happened, retry option)
208
+
209
+ ## Implementation Patterns
210
+
211
+ ### Technical approaches:
212
+
213
+ **Tooltip libraries**: Tippy.js, Popper.js
214
+ **Tour libraries**: Intro.js, Shepherd.js, React Joyride
215
+ **Modal patterns**: Focus trap, backdrop, ESC to close
216
+ **Progress tracking**: LocalStorage for "seen" states
217
+ **Analytics**: Track completion, drop-off points
218
+
219
+ **Storage patterns**:
220
+ ```javascript
221
+ // Track which onboarding steps user has seen
222
+ localStorage.setItem('onboarding-completed', 'true');
223
+ localStorage.setItem('feature-tooltip-seen-reports', 'true');
224
+ ```
225
+
226
+ **IMPORTANT**: Don't show same onboarding twice (annoying). Track completion and respect dismissals.
227
+
228
+ **NEVER**:
229
+ - Force users through long onboarding before they can use product
230
+ - Patronize users with obvious explanations
231
+ - Show same tooltip repeatedly (respect dismissals)
232
+ - Block all UI during tour (let users explore)
233
+ - Create separate tutorial mode disconnected from real product
234
+ - Overwhelm with information upfront (progressive disclosure!)
235
+ - Hide "Skip" or make it hard to find
236
+ - Forget about returning users (don't show initial onboarding again)
237
+
238
+ ## Verify Onboarding Quality
239
+
240
+ Test with real users:
241
+
242
+ - **Time to completion**: Can users complete onboarding quickly?
243
+ - **Comprehension**: Do users understand after completing?
244
+ - **Action**: Do users take desired next step?
245
+ - **Skip rate**: Are too many users skipping? (Maybe it's too long/not valuable)
246
+ - **Completion rate**: Are users completing? (If low, simplify)
247
+ - **Time to value**: How long until users get first value?
248
+
249
+ 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.