Skip to content

Commit 0fc9e64

Browse files
committed
docs: tighten writing style rules in CLAUDE.md
1 parent 275b679 commit 0fc9e64

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,13 +225,17 @@ These have caused real production bugs:
225225
- **SQL dumps can have single lines with millions of characters** — cap regex/highlight ranges at 10k chars.
226226
- **Tab persistence**: `QueryTab.toPersistedTab()` truncates queries >500KB to prevent JSON freeze. `TabStateStorage.saveLastQuery()` skips writes >500KB.
227227
228-
## Writing Style (Docs & Marketing Copy)
228+
## Writing Style
229229
230-
Write like a developer, not a marketing AI. Be specific (numbers, tech names) over generic adjectives. Vary sentence rhythm. Cut filler.
230+
Applies to **everything**: docs, commit messages, CHANGELOG entries, UI strings, error messages, PR descriptions.
231231
232-
**Banned words**: seamless, robust, comprehensive, intuitive, effortless, powerful (as filler), streamlined, leverage, elevate, harness, supercharge, unlock, unleash, dive into, game-changer, empower, delve. No "Absolutely!" / "Ready to dive in?" openers.
232+
**Write like a human developer.** Short sentences. Plain words. Say what it does, not how great it is. If a sentence works without a word, drop the word.
233233
234-
**Em dashes**: minimize; use colons or periods instead. Use hyphens (-) in `<title>` tags, never em dashes (—).
234+
**No em dashes (—).** Anywhere. Use a comma, period, colon, or rewrite the sentence. Hyphens (-) for compound words are fine.
235+
236+
**No AI-generated filler.** If it sounds like a chatbot wrote it, rewrite it. Banned words: seamless, robust, comprehensive, intuitive, effortless, powerful (as filler), streamlined, leverage, elevate, harness, supercharge, unlock, unleash, dive into, game-changer, empower, delve, utilize, facilitate. No "Absolutely!" / "Ready to dive in?" / "Let's get started!" openers.
237+
238+
**Be specific.** Numbers, tech names, file paths. "Runs in 200ms" beats "runs fast". "Uses `PQexecParams`" beats "uses native binding".
235239
236240
## CI/CD
237241

0 commit comments

Comments
 (0)