Editorial Style Guide: [publication / product]
Editorial style guide – voice, terms, rules
使い方: 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.
| Field | Value |
|---|---|
| Applies to | [docs / blog / all content] |
| Owner | @name |
| Version | N.N |
| Last review | YYYY-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
| Rule | Standard | Example |
|---|---|---|
| Serial comma | yes / no | "a, b, and c" |
| Numbers | [spell <= nine, digits >= 10] | |
| Dates | YYYY-MM-DD | |
| Capitalization | [sentence case headings] | |
| Dashes | en dash – for ranges, no spaced em dash |
Terminology
| Write this | Not this | Why |
|---|---|---|
| [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)
| Wrong | Right | Source (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].