Another Way to Continue a List of Things in a Paragraph
3. DOCUMENT DESIGN
3.3 Lists
Suzan Last
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.
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.
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)
- Labelled 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 a list).
BULLET LISTS
Bullet lists are the most commonly used kind of list. They are effective when
- You want to emphasize two or more items
- You can place the items in any order (no particular order is required)
- You want to add white space to your document to enhance readability.
Bullet list items should generally be short (a word or a phrase). If you find your bulleted items are longer than this, consider using another kind of list, such as a labelled list or a nested list.
NUMBERED LISTS
Use numbered lists when the order of the listed items is important and ideas must be expressed in chronological order. For example, use a numbered list when you must enumerate a series of steps in instructions, or when you are introducing ideas that will be discussed in a certain order in the following text. If you have a list of more than 8 items, consider breaking up the list in two or more stages or categories (Steps in Stage 1, Steps in Stage 2, etc.).
Revision of your document should be undertaken in 4 stages done in the following order:
- Check formatting for readability
- Review content to ensure the document contains all necessary information
- Edit sentence style and structure to ensure ideas are clearly and correctly expressed in a formal and precise manner
- Proofread for grammar, spelling, punctuation and usage errors.
NOTE: The 4 steps in the sample numbered list each begin with a verb (check, review, edit, and proofread), indicating what the reader should do, and the numbers indicate the order in which these steps should be performed.
IN-SENTENCE LISTS
Use in-sentence lists when you want to (a) keep paragraph style, (b) to avoid having too many lists on one page, and (c) when the list items are relatively short and can be expressed in a sentence clearly without creating a run-on. The previous sentence is an example of an in-sentence list. Note that a bracketed, lower-case letter introduces each listed item.
Typically, in-sentence lists have 2-4 items. Generally avoid putting more than 4 items in this kind of list (unless they are very short), or your sentence might become difficult to read.
LABELLED LISTS
Use a labelLed list when you are listing items that need further explanation. These can be bulleted or numbered. Start the list item with the word or term (the "label" portion), placed in italics and/or bold, and followed by a colon. After the colon, write the explanation or amplification of the term or concept in normal body text.
The course assessment plan includes three main written assignments given in the following order:
- Report One: an internal proposal written in Memo format
- Report Two: an internal proposal written in Short Report format
- Report Three: A comparative recommendation report written for an external client in Long Report format.
The plan also includes two oral presentations:
- Presentation 1: Individual or pair presentation on a technical writing topic (worth 5%)
- Presentation 2: Team presentation giving a progress report on Report 3 (worth 10%).
Make sure the label portions (before the colon) are phrased consistently and either italicized or bolded (or both!) for emphasis; try to make the explanations that follow roughly equal in length and detail.
NESTED LISTS
A "nested" list is a list-within-a-list or a list with sub-listed items. These can be useful for avoiding overly long bullet lists by categorizing items into sub-lists. Note the long bullet list on the left does not effectively categorize items, so emphasis is lost. The Nested List on the right is more effective.
| Sample Bullet List (too long) | Sample Nested List |
| Every restaurant should contain the following beverage containers:
(12 items is too many for one list!) | Every restaurant should contain the following kinds of beverage containers:
|
This is not an exhaustive list of the kinds of lists you may run across in your technical reading. These are simply the most common kinds of lists, and ones you should be able to identify and use effectively in your technical writing assignments to enhance readability.
Conventions for punctuating list items vary depending on the context. Legal writing tends to use more punctuation than technical writing (list items often end in semicolons and the final item is introduced by an "and"). In technical documents, because this style favours simplicity, you typically place a period only after the final item in your list. If each listed item has complete sentences within it, then you will place a period at the end of each list item. If you have a simple bullet list, you may omit the final period.
Five Kinds of List:
- Bullet lists
- numbered lists.
- Lists can be written within a sentence using bracketed letters to introduce the list items.
- nested list
- Also called a "list within a list"
- Labelled List
Just as there are rules for constructing lists, there are rules for how to incorporate them into your text. Most importantly, a list must be introduced by a lead-in sentence (or clause) that contains both a subject and a verb. Technical writers often use the expression "the following" somewhere in the lead-in sentence to clearly indicate that a list of items will follow.
If the lead-in is a complete sentence that contains both a subject and verb (ie. it could end in a period), it should end in a colon that introduces the listed items. If the sentence is not a complete thought, (ie. you could not put a period there) the lead-in should not end in any punctuation, and each listed item must be able to grammatically complete the lead-in sentence.
Complete lead-in sentence (ends in a colon)
The term design project must allow students to incorporate the following elements into their solution:
- Mechanical engineering principles
- Electrical engineering knowledge
- Software/programming basics.
Partial lead-in sentence (no punctuation after lead-in)
The term design project must allow students to design a solution using
- Mechanical engineering principles
- Electrical engineering knowledge
- Software/programming basics.
GRAMMAR TIP: One of the most common errors found in technical reports has to do with the introduction of lists and how these are punctuated. Here are some additional examples of how—and how NOT—to introduce lists.
Don't use a colon before a list unless the introduction to the list is a complete thought, that is, an independent clause. Remember this rule: if you can't put a period there, then you can't put a colon there.
In some cases, a list might not be helpful and instead might just over-complicate your document. In such cases, list your ideas in sentence form, within the paragraph, as in the final panda example below. A page with too many lists looks like an outline instead of a coherently expressed series of ideas.
| Pandas have the following traits:☑
Common characteristics of pandas include: ×
| Pandas are: ×
Pandas are ☑
Pandas have black and white fur, eat a vegetarian diet, and can solve difficult problems. ☑ |
- Our solution aims to meet the following objectives
- The design constraints that must be considered are
- All proposed designs must abide by the following constraints
- The proposed solutions offers many tangible benefits, such as
- The proposed solution offers the following tangible benefits
| 1. List type: | 2. List type: |
Revision of your document should be undertaken in 4 stages:
| The assessment plan for this course includes three main writing tasks:
|
| 3. List type: | 4. List type: |
The 7 Cs refers to seven characteristics of effective professional writing. This writing should be
| The term design project tests your knowledge of the following principles:
|
- Create your own list, using the Paragraph Tools in Word. For example, make a list of as many kinds of vehicles as you can think of, being as creative as you can. If you can think of more than 8, consider what kind of list would be most suitable.
- Could you categorize them into nested lists? What kind of categories?
- Consider what text would introduce and follow your list.
- What kind of document would contain a list of vehicle types? Who would read it?
- Read Farkas' article on "Understanding and using PowerPoint" (.pdf)[1] and create a set of bullet-listed notes summarizing his ideas on "Criteria for Creating Bullet Points."
Review the Lists PowerPoint for this chapter.
Source: https://pressbooks.bccampus.ca/technicalwriting/chapter/lists/
0 Response to "Another Way to Continue a List of Things in a Paragraph"
Publicar un comentario