Style Guide

This guide describes the style, formatting, and word choices to be used in Too Much Media's documentation. Documentation produced by following these guidelines will have a consistent appearance.

Abbreviation

• ID, not id. Exception: id when used that way in code.

Punctuation

Do not omit the final serial comma in a list. For example: foo, bar, and baz.

Numbers

In paragraph text, write out unsigned integers one through nine. Use digits for signed numbers, fractions, and numbers greater than nine. For example: Yesterday we upgraded seven servers and tomorrow we'll upgrade 12.

In function descriptions and code examples, use digits.

Suggested Spellings

Note: only use these spelling to refer to regular nouns. Refer to proper nouns by their real name; for example, a section named Xsell should be referred to as the Xsell section.

• Ad Tool, not adtool or ad-tool
• n. Cross-sell, not xsell or cross sell
• v. Cross-sale, not xsale or cross sale
• Linkcode, not link code
• Link Domain, not linkdomain
• NATS3 and NATS4, not NATS 3 or NATS v4
• Payvia, not pay via
• Popup, not pop-up
• Sign-up, not sign up or signup
• Statistic, not stat
• Trial member, not trial-member

Suggested Diction

• Use override as a verb, not a noun
  • Good: override the affiliate
  • Bad: override as the affiliate

Suggested URLs

• http://nats.example.com -- URL to a NATS
• http://example.com -- URL to a site
• http://signups.example.com -- URL to a linkdomain

Names

• Templates always singular
• The first word in article and section titles should be capitalized. All other title words should be capitalized, with the following exceptions: prepositions, articles, and conjunctions; proper nouns retain their case (for example: function names are in lowercase).