Barvna shema: Riviera
Trenutno dejavna stran: start » en » Documentation » Help » Editorial guide – The White Knight Labs » The ten rules that matter most

The ten rules that matter most

Version: 1.0 · Status: 2026-09-18 · Structural model: Microsoft Writing Style Guide – Top 10 tips (CC BY 4.0) · Normative basis: Microsoft Writing Style Guide; Merriam-Webster for spelling

If you have no time for the full guide, follow these ten rules. They cover the decisions that come up most often.

This version is not a translation of the German guide. Several rules differ, because English and German set different conventions. Where they conflict, the English rule applies here.

1. Lead with what matters

Open with the main point. Put keywords at the start of sentences and paragraphs so they stand out when the page is scanned.

Example

  • Weaker: If you want to make sure your systems meet the requirements of NIS2, our security check offers a first assessment.
  • Better: The security check shows in a few steps whether your systems meet NIS2.

2. Keep it short and clear

Cut every word that carries no meaning. Short sentences read faster than long ones — but never shorten a technical statement until it becomes imprecise.

3. Use active voice and real verbs

Carry the sentence on a verb, not on a chain of nouns. Name who does the thing.

Example

  • Weaker: The execution of the migration is performed by our team with consideration of existing systems.
  • Better: Our team migrates your systems and takes the existing ones into account.

4. Address the reader as "you"

Customer-facing content uses you; the company is we. Do not switch person within a text. English has no formal/informal distinction — where German chooses Sie, English simply uses you.

5. Use technical terms precisely and sparingly

Use a technical term correctly or not at all. Established English terms stay as they are (key exchange, hash, commit, ML-KEM). Spell out an acronym on first use.

6. Use sentence case in headings

Capitalize the first word and proper nouns; everything else stays lowercase. Title Case is not used in this documentation set, even though it is common elsewhere in English.

Example

  • Not used here: Secure Migration Of Your Legacy Systems
  • Correct: Secure migration of your legacy systems

7. No full stop in headings or short list items

Headings, subheadings, button labels and short list items take no closing punctuation. A question mark is acceptable where it fits the content.

8. Use the serial comma

This is the opposite of the German rule. In English, place a comma before the final and or or in a list of three or more.

Example

  • Correct: We review encryption, signatures, and key management.
  • (The German guide forbids this comma. Do not carry that rule into English.)

9. Use English typography

  • Quotation marks: „…“ (curly double quotes); single quotes inside a quotation.
  • Dash: the em dash — set without spaces, or an en dash with spaces. This differs from German, which uses only the spaced en dash.
  • Decimal separator: the point (3.5 GB), not the comma.
  • Thousands separator: the comma (1,000,000).
  • A space between number and unit: 5 kg, 100 MB, 50% takes no space in US usage.

10. Stay factual

Give evidence instead of emphasis. Describe risk precisely and without alarm; make a promise only when it is covered. Avoid superlatives and marketing phrases.

Example

  • Weaker: With the world's most secure solution your data is protected forever.
  • Better: Our encryption follows FIPS 203 and 204 and the BSI TR-02102 recommendations.

Editorial guide of The White Knight Labs. Structure follows the Microsoft Writing Style Guide (© Microsoft Corporation, CC BY 4.0); the rules and examples are written for this documentation set.

en/wiki/help/style-guide/top-10-tips-style-voice.txt · Zadnja sprememba: uporabnika 127.0.0.1