Documentation Standards › Considerations › Standards For Preparing Text Documentation › Presentation Conventions › Punctuation

Punctuation

• The abbreviations e.g. and i.e. should be avoided. If you do use them for parenthetical information, use periods between the letters. Do not write them as ie and eg. Terms such as for example and that is are preferred.
• When the word not is being used as a contrast, use boldface type. For instance:

  Not: not like this.

  But rather: not like this.

• Use a colon to indicate the start of a list of items.
• When a list consists of partial sentences or points, each on a different line, do not begin with a capital letter or end with a full stop, for instance:

  — command diagrams

  — chapter facing pages

  — CA 2E relation syntax diagrams

Where points are numbered, enter numbering as 1. and 2. with the numbers followed by a period. This applies to sub-points as well, which should be designated by letters a., b., and c. Avoid roman numerals, as they do not align properly.