Difference between revisions of "Wiki Style Guide"

Revision as of 23:05, 20 October 2016

Bullet Lists

• Start with a capitalized word
• Ending with a period is optional but be consistent

Definition Lists

• TODO -- Decide on the convention to separate the key/phrase for the bullet from the rest, e.g. in a key - definition bullet list

Notes

• TODO -- Decide on the syntax for "Note". Do we want: ";Note: <term>", or do we want "Note:"?
  • I vote for this variant:

  Note: This is a note.

  Actually this is a template that I created. See Template:Note. You can use it by writing something like {{Note|This is a note.}}

Use of Italics

• TODO -- Decide when we will use Italics within a sentence. Some times we use it when mentioning well-known terms.

Capitalization in Titles

Use Upper Case in the first letter of words in titles.

Proper Capitalization

Here are some names that should be capitalized properly:

• Apple
• Bluetooth
• Eddystone
• Google
• iBeacon
• IoT
• JavaScript
• JSON
• TypeScript
• URL
• URI
• Wi-Fi

Terminology Specific to the AMTech Platform

Below are the preferred ways to refer to concepts, features and other features of the AMTech Platform. Capitalization in the list below is to be taken verbatin, e.g. "Observer" is to be capitalized, even when it appears in the middle of a sentence.

• AMTech Platform
• IoT (note the Camel capitalization)
• M2MBridge
• Observer
• Thing