User`s guide

B Documentation Guidelines
B.2 Written Style
139
B
Punctuation
■
Always use a colon after the phrase or sentence introducing an example,
display, itemized list, or table.
■
A comma should always precede the conjunction and, or, or nor when it
separates the last of a series of three or more words or phrases. This comma is
not optional. For example:
apples, oranges, and bananas
■
Avoid the use of quotation marks. If they are necessary, form quotations using
the straight double-quote ( " ) only. Use single quotes only as described in
Special Words, p.159.
Word Usage
■
Do not use capital letters to convey emphasis; use italics. For information on
how to apply font changes, see Table B-5. In general, avoid applying italics for
emphasis—the best way to convey emphasis is a well cast sentence.
■
Do not use the word so to mean thus or therefore. However, the construction so
that is acceptable.
■
Do not use contractions (don’t, doesn’t, can’t, and so on).
Spelling
Table B-1 defines the Wind River standard for terms that are spelled inconsistently,
particularly in the computer industry. This table also includes a few words or
abbreviations that are commonly misspelled, and words whose spelling is
frequently misunderstood because it may depend on context.
Ta b le B -1 Spelling Conventions
Use... Not...
and so forth, among others etc.
back end backend
backward backwards
baseline base line
bit-field bit field
boot line bootline, boot-line