VNOX-Web/docs/copy-guidelines.md
loki5512344 d3a6dd316b
feat(web): rewrite site copy in plain language and split i18n dictionaries
Move RU/EN strings to src/i18n/{ru,en}.ts, add og/meta tags that follow the
selected language, remove the long dash from all text, add copy guidelines and
tests for key parity, HTML fallback text and dash-free sources and bundle.
2026-10-24 16:55:05 +02:00

12 lines
1.4 KiB
Markdown

# Copy guidelines
Short notes for writing site text in Russian and English. Based on README and landing-page advice from The Turing Way, openSUSE and others, Maxim Ilyakhov's "Пиши, сокращай" (Glavred stop-words), and articles on typical machine-written copy.
- Say what the thing is and for whom in the first sentence. List real things (channels, DMs, roles, encrypted voice) instead of slogans.
- Write only what the code does today. Planned items go under "next", never in the main description.
- Cut hype and filler: no "revolutionary", "seamless", "ecosystem", "powerful", "unlock"; in Russian no "осуществлять", "является", "данный", "в рамках", "обеспечивает возможность".
- Avoid the "not X, but Y" construction, triplets for rhythm, and openers like "Let's take a look". One plain sentence beats two clever ones.
- Prefer verbs and short sentences. Do not translate word for word: write the Russian and English versions separately, each as a person would say it.
- Use a full stop, comma, colon or brackets. The long dash character is banned in all site text; `tests/copy.test.ts` greps sources, docs and the built bundle for it.
- Titles and og/meta text follow the same rule, for example "VNOX: voice and text chat on your own server".
- Every user-visible string lives in `src/i18n/ru.ts` and `en.ts`. Keys must match; a test checks it.