markdowneditor

Editorial Style Guide: [publication / product]

Editorial style guide – voice, terms, rules

लेखन और सामग्रीमानकstyleguide
एडिटर में खोलें.md डाउनलोड करें

उपयोग कैसे करें: Two or more writers. Rules need examples and reasons; the exceptions clause prevents pedantry theater.

प्रीव्यू

Editorial Style Guide: [publication / product]

The rules that make many writers sound like one voice. A rule without an example gets ignored; a rule without a reason gets resented.

FieldValue
Applies to[docs / blog / all content]
Owner@name
VersionN.N
Last reviewYYYY-MM-DD

Voice

  • [3 adjectives – e.g. direct, helpful, unpretentious]
  • Write to one reader ("you"), not an audience
  • Active voice by default; passive only when the actor is irrelevant

Grammar & mechanics

RuleStandardExample
Serial commayes / no"a, b, and c"
Numbers[spell <= nine, digits >= 10]
DatesYYYY-MM-DD
Capitalization[sentence case headings]
Dashesen dash – for ranges, no spaced em dash

Terminology

Write thisNot thisWhy
[preferred term][banned term][reason]

Formatting

  • Headings: sentence case, no terminal period
  • Code: inline backticks; blocks with language tags
  • Links: descriptive text, never "click here"
  • Lists: parallel structure; periods only on full sentences
  • Images: alt text required, describes function

Inclusive language

  • [rules – e.g. neutral pronouns, no ablist terms]
  • [localization notes – things that don't translate]

Common mistakes (observed)

WrongRightSource (real example)

Exceptions & escalation

Rules yield to clarity. Disputes: @name arbitrates; document the outcome here.

Reference style

Fallback authority: [Chicago Manual / AP / internal decisions win].

संबंधित टेम्पलेट