In-house style

From MozillaZine Knowledge Base
Revision as of 01:05, 10 February 2005 by Hao2lian (talk | contribs) (Creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

This is just going to be a list of stylistic writing suggestions that can make this entire KB more consistent in writing for now, in an informal bullet form. Feel free to add or delete any changes, since I border on grammar nazi. --hao2lian

  • Use arrows to denote menu order (e.g. "Tools -> Options").
  • Use bolding and italics only when absolutely necessary.
  • Don't start too many small, idiosyncratic paragraphs. If paragraphs are a couple of sentences that last about two lines, try and see if you can combine them into one paragraph.
  • Just a personal pet peeve: use the dash and hyphen correctly [1] [2].
  • Stop using the "Firefox : FAQs : Topic" format, since it's been in the Rules for a while now. Change to general topic names like "Help old ladies across the street" with an optional "(Firefox)" if it only applies to one product.
  • Use infinitives instead of conjugated verbs in the topic. By that, I mean use "Help old ladies" instead of "Helping old ladies" or "Helped old ladies" or "Have helped old ladies".