← Back to Book Detail

3.3 Lists (10/19) -- Technical Writing Essentials - H5P Editi...

Browse
52%

3.3 Lists

3.3 Lists Lists, when used correctly, can be a technical writer’s—and reader’s—best friend. Lists allow you to emphasize important ideas. They also increase the readability of text by simplifying long sentences or paragraphs and adding aesthetic passive space to make reading more pleasant. However, using the wrong kind of list or poorly formatting a list can create confusion rather than enhance readability. Therefore, it is important to understand the various types of lists and how and why to use them. Example Lead-in Sentences for Lists Adhere to the following guidelines when creating lists of any kind: - Include between 2-8 items in a list. You must have at least two items in a list (or it’s not a list; it’s just an item). Avoid having more than 8 items in a list, as too many items can have the reverse effect. If you emphasize too many ideas, you end up emphasizing nothing. NASA recommends no more than 8 steps in an emergency procedure; more than 8 can be overwhelming in a crisis situation. - Try to avoid splitting a list over two pages if possible. - Avoid overusing lists. A list should always have explanatory text around it to indicate what this is a list of and why it is needed. A series of lists does not give a reader adequate information and context. - Adjust spacing before, after, and within lists to enhance readability. Avoid having a list of information all scrunched up into a dense block of text; this defeats the purpose of enhancing readability. - Capitalize the first letter of each list item. - Use parallel phrasing for each listed item (note that each item in this list starts with a verb that is bolded only to catch your attention, not as a style you must follow). - Never use a heading to introduce a list. Each kind of list is suited for specific purposes. All lists must conform to a set of rules of construction and formatting. Learning to use the Paragraph formatting tool in Word (see Figure 3.3.1) is crucial to designing effective lists. NOTE: If you are making lists by hitting ENTER then TAB and then a dash, you are doing it wrong, and this will make future editing and maintaining readability very difficult if not impossible. Especially when writing documents collaboratively that will need extensive revision and editing, you must make sure to use the correct formatting tools. Common Types of Lists Just as bar graphs serve a different purpose than pie charts, different kinds of lists also serve different purposes. This section will describe when and how to use the following five commonly used types of lists: - Bullet Lists: use when order of listed items is not important - Numbered Lists: use when order is important, such as steps in instructions - In-sentence Lists: use when you want to maintain sentence structure and paragraphing, and have a short list (2-4 items) - Labeled Lists: use when the listed items require some explanation or amplification (like this one) - Nested Lists: use when listed items have sub-lists (list within
← Previous Chapter Next Chapter →