-
Notifications
You must be signed in to change notification settings - Fork 6
chore: update docs #93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| name: sweetr-brand-voice | ||
| 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. | ||
| --- | ||
|
|
||
| # Sweetr Brand Voice | ||
|
|
||
| Apply Sweetr's brand voice, terminology, and positioning when writing any copy. | ||
|
|
||
| ## Setup | ||
|
|
||
| Read the full brand kit before writing: | ||
|
|
||
| - **[BRAND_KIT.md](references/BRAND_KIT.md)** — Complete brand identity, positioning, differentiators, voice guidelines, messaging framework, terminology, and do's/don'ts. | ||
|
|
||
| ## Workflow | ||
|
|
||
| ### For website copy (headlines, features, CTAs, sections) | ||
|
|
||
| 1. Read BRAND_KIT.md sections 1–4 and 6 (Identity, Positioning, Differentiators, Voice, Terminology). | ||
| 2. Identify which differentiator(s) the copy should reinforce. | ||
| 3. Match tone to context (see "Tone by context" table in brand kit). | ||
| 4. Write copy. Validate against the "Words we avoid" list. | ||
| 5. Confirm the copy does not use "open source", surveillance language, or corporate-speak. | ||
|
|
||
| ### For blog articles | ||
|
|
||
| 1. Read BRAND_KIT.md sections 4, 5, and 9 (Voice, Messaging Framework, Blog Voice). | ||
| 2. Write in founder-led, conversational tone. Be opinionated. Frame problems from the developer's POV. | ||
| 3. Use the core narrative arc: world changed → gap exists → existing options fail → Sweetr is different → outcome. | ||
| 4. End with a community-inviting CTA (try, star, contribute, give feedback). | ||
| 5. Never name competitors directly. | ||
|
|
||
| ### For meta descriptions and SEO copy | ||
|
|
||
| 1. Use "Developer Intelligence Platform" as the category term. | ||
| 2. Include relevant keywords: DORA metrics, developer experience, engineering performance. | ||
| 3. Keep the `++` motif for brand recognition when space allows. | ||
|
|
||
| ## Critical rules (always apply) | ||
|
|
||
| - **Never call Sweetr "open source."** We are fair source (FSL license). Use "fair source", "source-available", or "built in the open." | ||
| - **Never use surveillance language** (monitor, track individuals, rank, score developers). | ||
| - **Never name competitors.** | ||
| - **Always frame features as team/process improvements**, never as individual measurement. | ||
| - **Brand name is `sweetr.dev`** (lowercase, with `.dev`). Short form: Sweetr (capital S only). | ||
| - **Never use em dashes (—).** Use periods, commas, or restructure the sentence instead. | ||
| - **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. | ||
352 changes: 352 additions & 0 deletions
352
.cursor/skills/sweetr-brand-voice/references/BRAND_KIT.md
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.