Lists
From TechWriter Wiki
Contents |
Introduction
There are principally two types of lists: numbered lists and bulleted lists. It is also possible to use simple lists without numbers or bullets (although this is not recommended - the use of bullets or numbers emphasizes that it is a list), or multi-column lists (sometimes referred to as directory lists).
Numbered lists
Numbered lists should be used where the sequence of the list items is important, or where it is desirable to emphasize the number of items in the list.
Example:
The project is split into five stages:
- Needs Analysis;
- Project Definition;
- Solution Design;
- Solution Development;
- Implementation.
Nested numbered lists
When nesting numbered lists, use a different format of number for each level. This will make it much easier to identify the nesting level. For quick scanning of lists it is a good idea to use a combination of (for example) Arabic numerals, Latin letters, and Roman numerals, as shown in the example below.
Example:
- Level 1 First item;
- Level 1 Second item;
- Level 2 First item;
- Level 2 Second item;
- Level 3 First item;
- Level 3 Second item;
- Level 2 Third item;
- Level 1 Third item;
An exception to this would be where it is necessary to refer to individual items within the nested lists. To refer to the second item in the level three list above, we would need to use "2.b.ii" which can be confusing - especially where it is recited verbally. In such cases, use of a single list type for all levels - and typically the default decimal type - would be preferrable: "2.2.2".
Bulleted lists
Bulleted lists should be used where the sequence if the list items is not important. Because the sequence is not important, it may be useful to decide upon some other criteria for ordering the items within the list. Common options are alphabetic order, and order of importance (or frequency).
Example:
The Project Definition stage of the project results in the following deliverables:
- Business requirements definition;
- Preferred solution description;
- Change management plan;
- Benefits assessment and capture plan;
- Resource requirements definition.
Nested bulleted lists
When nesting bulleted lists, use a different symbol for the bullet at each level. This will make it much easier to identify the nesting level. There is no hard and fast rule for which symbols to use - or in what order - but it is common to use circles then triangles then squares. Should more than three levels be needed, consider using 'hollow' circle, triangle, and square symbols.
Example:
- Level 1 First item;
- Level 1 Second item;
- Level 2 First item;
- Level 2 Second item;
- Level 3 First item;
- Level 3 Second item;
- Level 2 Third item;
- Level 1 Third item;
Directory lists
Directory lists (or multi-column lists) are useful where you have a list comprising of a (relatively) large number of short items. Directory lists are typically simple lists (that is, without bullets or numbers) which implies that the order is not significant, although bullets or numbering could also be used.
Example:
As of the date of this document, the following countries are members of the European Union:
| Austria | Finland | Lithuania | Slovakia |
| Belgium | France | Luxembourg | Slovenia |
| Bulgaria | Germany | Malta | Spain |
| Cyprus | Greece | Netherlands | Sweden |
| Czech Republic | Hungary | Poland | United Kingdom |
| Denmark | Italy | Portugal | |
| Estonia | Latvia | Romania |
Note that if the items are to be listed alphabetically, a choice needs to be made as to whether this is done horizontally (by row) or vertically (by column). Either method can be used (but should be used consistently) although verticaly - as shown in the example above - is the most common choice.
