Skip to content

Commit aa26e4c

Browse files
authored
chore: update docs (#93)
* chore: wip * chore: update docs * feat: docs update * fix: pr review
1 parent 4f9ab4a commit aa26e4c

58 files changed

Lines changed: 2217 additions & 379 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: sweetr-brand-voice
3+
description: Sweetr brand voice and copywriting guide. Use when writing or editing any copy for sweetr.dev, including website headlines, feature descriptions, landing page sections, blog articles, meta descriptions, CTA text, changelog entries, social media posts, or any user-facing marketing text. Also use when reviewing existing copy for brand consistency.
4+
---
5+
6+
# Sweetr Brand Voice
7+
8+
Apply Sweetr's brand voice, terminology, and positioning when writing any copy.
9+
10+
## Setup
11+
12+
Read the full brand kit before writing:
13+
14+
- **[BRAND_KIT.md](references/BRAND_KIT.md)**: Complete brand identity, positioning, differentiators, voice guidelines, messaging framework, terminology, and do's/don'ts.
15+
16+
## Workflow
17+
18+
### For website copy (headlines, features, CTAs, sections)
19+
20+
1. Read BRAND_KIT.md sections 1–4 and 6 (Identity, Positioning, Differentiators, Voice, Terminology).
21+
2. Identify which differentiator(s) the copy should reinforce.
22+
3. Match tone to context (see "Tone by context" table in brand kit).
23+
4. Write copy. Validate against the "Words we avoid" list.
24+
5. Confirm the copy does not use "open source", surveillance language, or corporate-speak.
25+
26+
### For blog articles
27+
28+
1. Read BRAND_KIT.md sections 4, 5, and 9 (Voice, Messaging Framework, Blog Voice).
29+
2. Write in founder-led, conversational tone. Be opinionated. Frame problems from the developer's POV.
30+
3. Use the core narrative arc: world changed → gap exists → existing options fail → Sweetr is different → outcome.
31+
4. End with a community-inviting CTA (try, star, contribute, give feedback).
32+
5. Never name competitors directly.
33+
34+
### For meta descriptions and SEO copy
35+
36+
1. Use "Developer Intelligence Platform" as the category term.
37+
2. Include relevant keywords: DORA metrics, developer experience, engineering performance.
38+
3. Keep the `++` motif for brand recognition when space allows.
39+
40+
## Critical rules (always apply)
41+
42+
- **Never call Sweetr "open source."** We are fair source (FSL license). Use "fair source", "source-available", or "built in the open."
43+
- **Never use surveillance language** (monitor, track individuals, rank, score developers).
44+
- **Never name competitors.**
45+
- **Always frame features as team/process improvements**, never as individual measurement.
46+
- **Brand name is `sweetr.dev`** (lowercase, with `.dev`). Short form: Sweetr (capital S only).
47+
- **Never use em dashes (—).** Use periods, commas, or restructure the sentence instead.
48+
- **Sound human, not like AI.** Avoid fancy/flowery words that real developers would never say. Banned words include: erode, delve, elevate, harness, foster, empower, unleash, bolster, spearhead, holistic, pivotal, transformative, streamline, paradigm, synergy, encompass, multifaceted, nuanced, underscore, facilitate, robust, scalable (unless literally about infrastructure), seamless, cutting-edge, groundbreaking, unparalleled, fortify, commencing, aforementioned, culminate, discern, elucidate, endeavor, intricate, myriad, paramount, perpetuate, proliferate, quintessential, resonate, subsequently, traverse, utilize (use "use"), whilst, navigate (as metaphor), landscape (as metaphor), ecosystem (unless literal), moreover, furthermore, additionally, comprehensive, meticulous, realm, testament, embark, journey (as metaphor), pave the way, shed light on, at its core, notably, interestingly, crucial, it's worth noting that, in today's [anything] world. If a word feels like it belongs in a college essay, pick a simpler one.

.cursor/skills/sweetr-brand-voice/references/BRAND_KIT.md

Lines changed: 352 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)