Difference between revisions of "Wiki Style Guide"
From AMTech WikiDocs
(Added Capitalization Section) |
|||
| Line 2: | Line 2: | ||
* Start with a capitalized word | * Start with a capitalized word | ||
* Ending with a period is optional but be consistent | * Ending with a period is optional but be consistent | ||
| + | * TODO -- Decide on the convention to separate the key/phrase for the bullet from the rest, e.g. in a key - definition bullet list | ||
| + | |||
| + | == Capitalization in Titles == | ||
| + | Use Upper Case in the first letter of words in titles. | ||
== Proper Capitalization == | == Proper Capitalization == | ||
Here are some names that should be capitalized properly: | Here are some names that should be capitalized properly: | ||
| + | * Apple | ||
| + | * Bluetooth | ||
| + | * Eddystone | ||
| + | * Google | ||
| + | * iBeacon | ||
| + | * IoT | ||
* JavaScript | * JavaScript | ||
| + | * JSON | ||
* TypeScript | * 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 | ||
| + | * Thing | ||
| + | * Observer | ||
Revision as of 16:39, 20 October 2016
Contents
Bullet Lists
- Start with a capitalized word
- Ending with a period is optional but be consistent
- TODO -- Decide on the convention to separate the key/phrase for the bullet from the rest, e.g. in a key - definition bullet list
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
- 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
- Thing
- Observer
