@equal-experts/kuat-react 0.2.2 → 0.2.4

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.
@@ -0,0 +1,454 @@
1
+ # Kuat Design System Marketing, Sales & Knowledge Content Guide
2
+
3
+ ---
4
+ **Version:** 1.0
5
+ **Last Updated:** December 2024
6
+ **Type:** Specialized Guidelines
7
+ **Audience:** Marketing, Sales, PR, Business Development, Content Marketers
8
+ **Dependencies:** [`content-foundations.md`](./content-foundations.md) (read first)
9
+
10
+ ---
11
+
12
+ ## Prerequisites
13
+
14
+ **⚠️ Important:** You must read [`content-foundations.md`](./content-foundations.md) before using this guide.
15
+
16
+ This guide builds on the universal brand voice principles. It assumes you understand:
17
+ - Core voice principles
18
+ - Universal content principles
19
+ - Audience considerations
20
+ - Common anti-patterns
21
+ - Quality tests
22
+
23
+ ---
24
+
25
+ ## Quick Reference: Marketing Content at a Glance
26
+
27
+ **Marketing content should:**
28
+ - Build awareness and reputation
29
+ - Demonstrate expertise through evidence
30
+ - Generate leads and opportunities
31
+ - Educate external audiences
32
+ - Position the Kuat Design System as a valuable solution
33
+
34
+ **Tone range:** Confident to conversational (depends on content type)
35
+ **Key balance:** Expertise + Clarity = Credibility
36
+ **Primary audience:** Prospective users, existing users, practitioners, industry peers
37
+
38
+ ---
39
+
40
+ ## Content Type Decision Tree
41
+
42
+ **What are you creating?**
43
+
44
+ → **Proving capability to prospects?** → Case Studies
45
+ → **Sharing expertise/insights?** → Blogs
46
+ → **Teaching methodology?** → Playbooks
47
+ → **Persuading to choose us?** → Pitch Decks
48
+ → **Engaging community?** → Social Media
49
+ → **Sharing internally?** → Internal Communications
50
+ → **Positioning thought leadership?** → Whitepapers/Research
51
+ → **Website copy?** → Web Copy
52
+ → **Email campaigns?** → Email Marketing
53
+
54
+ ---
55
+
56
+ ## Case Studies
57
+
58
+ **Tone:** Straightforward and factual with focus on storytelling, results, and value
59
+
60
+ **Purpose:** Demonstrate how the Kuat Design System helped teams achieve their goals
61
+
62
+ **Target Audience:**
63
+ - Prospective users evaluating design systems
64
+ - Current users considering expanded usage
65
+ - Internal teams learning from implementations
66
+
67
+ ### Key Characteristics
68
+
69
+ ✅ **Do:**
70
+ - Tell a story: Challenge → How we solved it → Results
71
+ - Highlight the design system's role and value
72
+ - Make understandable by anyone (even without technical knowledge)
73
+ - Include specific, measurable business results
74
+ - Show how teams became more efficient
75
+
76
+ ❌ **Don't:**
77
+ - Use buzzwords without evidence
78
+ - Skip the measurable outcomes
79
+ - Ignore team contributions
80
+ - Write only for technical audiences
81
+
82
+ ### Required Structure
83
+
84
+ 1. **Context Setting** - What was the situation?
85
+ 2. **Challenge Identification** - What specific problems needed solving?
86
+ 3. **Our Approach** - How did the design system help?
87
+ 4. **Solution and Implementation** - What did we build/change?
88
+ 5. **Measurable Business Results** - What was the impact?
89
+
90
+ ### Example - GOOD
91
+
92
+ ```markdown
93
+ # Accelerating Development with the Kuat Design System
94
+
95
+ ## The Challenge
96
+
97
+ A fintech startup was struggling with inconsistent UI components across their React and Vue applications. Their design and development teams were spending 4-5 days per sprint aligning on implementation details for similar components, and design-to-code handoff was taking 2-3 days per feature.
98
+
99
+ The lack of a centralized design system meant:
100
+ - Inconsistent user experiences across products
101
+ - Duplicate component development
102
+ - Slow feature delivery
103
+ - High maintenance costs
104
+
105
+ ## Our Approach
106
+
107
+ We implemented the Kuat Design System, providing a unified component library for both React and Vue applications. The system uses shared CSS variables from `@equal-experts/kuat-core`, ensuring visual consistency while allowing framework-specific implementations.
108
+
109
+ ## The Solution
110
+
111
+ Over three months, we:
112
+ - Established the Kuat Design System with React and Vue packages
113
+ - Migrated 12 existing components to the new system
114
+ - Created comprehensive documentation for designers and developers
115
+ - Integrated the system into existing workflows (Figma plugins, PR templates)
116
+ - Trained the team on component usage and contribution
117
+
118
+ The team actively participated in component design decisions and contributed new components, ensuring they deeply understood the system.
119
+
120
+ ## Results
121
+
122
+ **Development Impact:**
123
+ - Component development time reduced by 60%
124
+ - Design-to-code handoff time reduced from 2-3 days to 2-3 hours
125
+ - Consistent UI patterns across all applications
126
+ - 40% reduction in UI-related bugs
127
+
128
+ **Team Efficiency:**
129
+ - Designers and developers aligned on patterns from day one
130
+ - New team members onboarded 3x faster
131
+ - Component reuse increased from 15% to 78%
132
+
133
+ **Business Impact:**
134
+ - Features shipped 2 weeks faster on average
135
+ - Reduced design system maintenance overhead by 50%
136
+ - Improved user experience consistency scores by 35%
137
+
138
+ **Team Quote:**
139
+ "The Kuat Design System didn't just give us components—it gave us a shared language. Our design and development teams now work together seamlessly, and we're shipping features faster than ever."
140
+ — Lead Product Designer
141
+ ```
142
+
143
+ ### Tips for Writing Great Case Studies
144
+
145
+ **Start with the business problem, not the technology:**
146
+ - ❌ "The team's component library was outdated"
147
+ - ✅ "Inconsistent components were causing 4-5 days of alignment work per sprint"
148
+
149
+ **Use specific numbers:**
150
+ - ❌ "We significantly improved their development speed"
151
+ - ✅ "Component development time reduced by 60%"
152
+
153
+ **Show real value:**
154
+ - ❌ "We built a design system"
155
+ - ✅ "The design system reduced design-to-code handoff from 2-3 days to 2-3 hours"
156
+
157
+ ---
158
+
159
+ ## Blogs (External & Internal)
160
+
161
+ **Tone:** Purposeful and informative with author's personality shining through
162
+
163
+ **Purpose:** Share insights, answer questions, demonstrate thought leadership
164
+
165
+ **Target Audience:**
166
+ - Practitioners seeking to learn
167
+ - Potential users researching topics
168
+ - Industry peers engaging with ideas
169
+ - Internal teams sharing knowledge
170
+
171
+ ### Key Characteristics
172
+
173
+ ✅ **Do:**
174
+ - Let author's style and voice come through
175
+ - Answer specific questions audience may have
176
+ - Make it insightful and understandable
177
+ - Include concrete examples and evidence
178
+ - Provide practical takeaways
179
+ - Add compelling calls to action
180
+
181
+ ❌ **Don't:**
182
+ - Write generic content that could be from anyone
183
+ - Make unsupported claims
184
+ - Use promotional language excessively
185
+ - Skip the evidence and examples
186
+
187
+ ### Required Structure
188
+
189
+ 1. **Captivating Introduction** - Pique curiosity with a story, question, or surprising insight
190
+ 2. **Clear Problem/Question** - State what you're addressing
191
+ 3. **Evidence-Based Insights** - Share what you've learned with specific examples
192
+ 4. **Practical Takeaways** - Give readers something actionable
193
+ 5. **Compelling CTA** - Invite further engagement
194
+
195
+ ### Example - GOOD
196
+
197
+ ```markdown
198
+ # Why Your Design System Might Be Failing (And How to Fix It)
199
+
200
+ Three months into a design system project, a product manager pulled me aside. "We built this beautiful component library," she said, "but nobody's using it. What went wrong?"
201
+
202
+ I've heard this story too many times. Organizations invest heavily in design systems, expecting them to accelerate development and ensure consistency. Instead, they get dusty documentation and frustrated designers building components from scratch.
203
+
204
+ ## The problem isn't the system itself
205
+
206
+ In my experience across 15+ design system projects, failure rarely stems from technical implementation. The best-designed component library in the world won't succeed if teams don't adopt it.
207
+
208
+ Here's what I've learned about why design systems fail—and more importantly, how to prevent it.
209
+
210
+ ## Start with actual problems, not aspirations
211
+
212
+ **The Failure Pattern:**
213
+ "We need a design system" becomes the goal, rather than solving real team problems.
214
+
215
+ **What Works Instead:**
216
+ A fintech client came to us wanting a comprehensive design system. Through interviews with their product teams, we discovered the real pain: designers and developers were spending 4-5 days per sprint aligning on implementation details for similar components.
217
+
218
+ We started small: standardized their 3 most-used components with clear documentation and Figma-to-code handoff. Adoption was immediate because it solved a daily frustration. We expanded from there, letting actual usage guide priorities.
219
+
220
+ **The lesson:** Design systems should solve problems teams already have, not problems you think they'll have.
221
+
222
+ ## Embed adoption into existing workflows
223
+
224
+ **The Failure Pattern:**
225
+ "Build it and they will come" - assuming documentation alone drives adoption.
226
+
227
+ **What Works Instead:**
228
+ At a UK retail company, we embedded design system adoption into their existing workflow:
229
+ - PR templates included component library checklist
230
+ - Design reviews specifically flagged inconsistent patterns
231
+ - Slack bot suggested relevant components during discussions
232
+ - Monthly "component clinic" pairing sessions
233
+
234
+ Six months in, component reuse increased from 12% to 78%. Teams adopted the system because it made their existing work easier, not because we asked them to change their process.
235
+
236
+ **The lesson:** Don't add design systems on top of existing workflow. Integrate them into how teams already work.
237
+
238
+ ## Measure impact continuously
239
+
240
+ **The Failure Pattern:**
241
+ Success measured by component count or documentation pages, not actual business value.
242
+
243
+ **What Works Instead:**
244
+ We helped a healthcare client track:
245
+ - Time-to-implement common patterns (decreased 60%)
246
+ - Design-dev alignment meetings (reduced from 12 hours to 3 hours per sprint)
247
+ - Accessibility violations in production (dropped 85%)
248
+ - Designer satisfaction with handoff process (improved from 4.2 to 8.7/10)
249
+
250
+ These metrics showed real value to leadership and helped secure ongoing investment.
251
+
252
+ **The lesson:** Measure the problems you're solving, not just the assets you're building.
253
+
254
+ ## Key Takeaways
255
+
256
+ Design systems succeed when they:
257
+ 1. Solve real problems teams experience daily
258
+ 2. Integrate into existing workflows seamlessly
259
+ 3. Show measurable impact on team effectiveness
260
+ 4. Grow based on actual usage, not assumptions
261
+
262
+ Start small, embed deeply, measure continuously. That's the path to a design system that actually gets used.
263
+
264
+ ---
265
+
266
+ **Facing design system challenges?** I'd love to hear what's working (or not working) for your team. [Email me](mailto:...) or connect on [LinkedIn](link).
267
+
268
+ Want to learn more about the Kuat Design System? [Get in touch with our team](link).
269
+ ```
270
+
271
+ ---
272
+
273
+ ## Social Media Content
274
+
275
+ **Tone:** Conversational, friendly, informal
276
+
277
+ **Purpose:** Engage audience, build community, share insights, drive traffic
278
+
279
+ **Target Audience:**
280
+ - Practitioners and potential users
281
+ - Prospective users researching online
282
+ - Industry peers and community
283
+ - Existing users staying engaged
284
+
285
+ ### Platform-Specific Guidelines
286
+
287
+ #### LinkedIn
288
+
289
+ **Tone:** Professional but conversational and warm
290
+
291
+ **Best Practices:**
292
+ - Direct posts at audience using "you"
293
+ - Ask questions to drive engagement
294
+ - Use 3-5 relevant hashtags
295
+ - Aim for 1,200-1,500 characters for longer posts
296
+ - Include images or documents when possible
297
+ - Post during business hours
298
+
299
+ **Example - GOOD:**
300
+
301
+ ```
302
+ Are you building a design system that supports multiple frameworks? 🤔
303
+
304
+ We've seen this pattern across 15+ teams: you start with React, then need Vue support, and suddenly you're maintaining two separate component libraries.
305
+
306
+ Here's what we're learning from teams getting it right:
307
+
308
+ → Share design tokens (colors, spacing, typography) across frameworks
309
+ → Use a monorepo structure to keep code close but separate
310
+ → Document patterns, not just components
311
+ → Build framework-specific implementations on shared foundations
312
+
313
+ The teams that succeed treat the design system as a shared language, not a shared codebase.
314
+
315
+ What challenges are you facing with multi-framework design systems? Let's discuss in the comments. 👇
316
+
317
+ #DesignSystems #React #Vue #FrontendDevelopment #UIComponents
318
+ ```
319
+
320
+ ---
321
+
322
+ ## Internal Communications
323
+
324
+ **Tone:** Friendly, approachable, authentic
325
+
326
+ **Purpose:** Share knowledge, build community, facilitate discussion internally
327
+
328
+ **Target Audience:**
329
+ - Team members globally
330
+ - Practice communities
331
+ - Leadership and teams
332
+
333
+ ### Key Characteristics
334
+
335
+ ✅ **Do:**
336
+ - Share quickly, don't over-polish
337
+ - Reflect your authentic voice
338
+ - Be concise and straightforward
339
+ - Use humor and informal language
340
+ - Focus on lessons learned
341
+ - Be generous with knowledge
342
+
343
+ ❌ **Don't:**
344
+ - Share sensitive information
345
+ - Badmouth colleagues
346
+ - Forget the whole team can see it
347
+ - Make others look bad
348
+
349
+ ---
350
+
351
+ ## Writing Best Practices
352
+
353
+ ### General Guidelines
354
+
355
+ ✅ **DO:**
356
+ - Write for all readers (skimmers and deep readers)
357
+ - Focus on key message upfront
358
+ - Use active voice predominantly
359
+ - Be clear, concise, and specific
360
+ - Write like a human, not a corporation
361
+ - Adapt to your audience
362
+ - Be consistent in tone and style
363
+ - Use descriptive headers and structure
364
+ - Lead with most interesting content
365
+ - Use plain English where possible
366
+ - Show examples, don't just tell principles
367
+
368
+ ❌ **DON'T:**
369
+ - Use passive voice unnecessarily
370
+ - Assume prior knowledge without context
371
+ - Use jargon without explanation
372
+ - Overuse "we" (can seem boastful)
373
+ - Mix tones and styles inconsistently
374
+ - Write vague or fluffy content
375
+ - Be overly promotional
376
+ - Make unsupported claims
377
+ - Write generic content
378
+ - Use buzzwords as a crutch
379
+
380
+ ### Active vs Passive Voice
381
+
382
+ **Active Voice (GOOD):**
383
+ - "The design system reduced development time by 40%"
384
+ - "Teams adopted the components within 2 weeks"
385
+ - "The component library improved consistency across applications"
386
+
387
+ **Passive Voice (AVOID):**
388
+ - "Development time was reduced by 40%"
389
+ - "Components were adopted within 2 weeks"
390
+ - "Consistency was improved across applications"
391
+
392
+ ### Accessibility and Inclusivity
393
+
394
+ ✅ **DO:**
395
+ - Use gender-neutral language
396
+ - Avoid idioms or explain them for global audience
397
+ - Use disability-aware language
398
+ - Be thoughtful with technical terms
399
+ - Make content accessible to all readers
400
+
401
+ ❌ **DON'T:**
402
+ - Use gendered pronouns as default
403
+ - Reinforce stereotypes about roles or capabilities
404
+ - Use disability as metaphor
405
+ - Make assumptions about identity or background
406
+
407
+ ---
408
+
409
+ ## Quality Checklist for Marketing Content
410
+
411
+ Before publishing, verify:
412
+
413
+ **Purpose and Audience:**
414
+ - [ ] Clear purpose and audience identified
415
+ - [ ] Content serves specific business goal
416
+ - [ ] Tone appropriate for content type and audience
417
+
418
+ **Content Quality:**
419
+ - [ ] Specific and detailed (not generic)
420
+ - [ ] Evidence-based claims with examples
421
+ - [ ] Active voice used predominantly
422
+ - [ ] Plain English where possible
423
+ - [ ] No unsupported claims or vague promises
424
+
425
+ **Accessibility:**
426
+ - [ ] Gender-neutral language used
427
+ - [ ] No unnecessary jargon
428
+ - [ ] Inclusive and accessible language
429
+
430
+ **Mechanics:**
431
+ - [ ] Proper attribution for quotes/sources
432
+ - [ ] Style guide followed (numbers, dates, punctuation)
433
+ - [ ] Proofread for spelling and grammar errors
434
+ - [ ] Links work and are descriptive
435
+
436
+ **Call to Action:**
437
+ - [ ] Compelling CTA present (if appropriate)
438
+ - [ ] Clear next steps for reader
439
+
440
+ ---
441
+
442
+ ## Additional Resources
443
+
444
+ - **Content Foundations:** See [content-foundations.md](./content-foundations.md) for universal principles
445
+ - **Product Content Guide:** See [content-product-ux.md](./content-product-ux.md) for product interface content
446
+ - **Design System Overview:** See [../design/design-system.md](../design/design-system.md) for design token usage
447
+ - **Component Guidelines:** See [../technical/component-guidelines.md](../technical/component-guidelines.md) for component patterns
448
+
449
+ ---
450
+
451
+ **Remember:** Marketing content builds reputation and trust. Be generous with knowledge, specific with evidence, clear in tone, and valuable to your audience. When in doubt, ask: "Would this make someone want to use the Kuat Design System?"
452
+
453
+ For universal principles and detailed quality tests, always reference [`content-foundations.md`](./content-foundations.md).
454
+