Difference between revisions of "Wiki Style Guide"

Revision as of 16:52, 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 how syntax for "Note". Do we want: ";Note: <term>", or do we want "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

These are the preferred ways to refer to concepts, features and other features of the AMTech Platform (note the Capitalization)

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