doc\ALL: list formatting consolidation
Check lists and match style guide:
Lists are useful to structure information with similar characteristics.
- Introduce lists with complete sentences, ending with a colon.
- Start all list items with an uppercase letter.
- Ensure similar structure for all list items, for example, whole sentences vs. nouns.
- End sentences with a period.
- Do not use closing punctuation for single words, noun phrases, verbs, adjectives, etc.
OK:
My pets like the following:
- My cat likes to hunt in the fields.
- My dog is happy when we go out for a walk.
- My guinea pig wants to sleep all day.
OK:
I like the following types of fruit:
- Apples
- Bananas
- Cherries
Do not write lists as a continuous sentence.
NOK:
ASAM is responsible for
- development of standards,
- toolkits for standard users, and
- documentation for end users.
OK:
ASAM is responsible for the following tasks:
- Standard development
- Toolkit development
- End-user documentation
Lists – Procedures
- Use numbered lists for ordered items or procedures.
- Provide a title for each procedure.
- Describe only one action in each numbered step.
- Provide important information before describing the steps to make sure that the reader knows it in time.
- Separate actions and action results. Write the result in a new sentence (on a new line).
- Describe the expected result of the procedure.