GNOME.org

Lists

Lists break information from the standard paragraph format into a concise, organized, easy-to-read format. You can use the following types of lists:

  • Unnumbered lists, also known as bullet lists or itemized lists
  • Numbered lists
  • Lists of terms with a description for each term, known as variable lists

2.5.1. General Guidelines for Writing Lists

Use the following guidelines to write lists:

  • Use unnumbered lists where the entries in the list are of the same importance and do not follow a sequence.
  • Use numbered lists where the entries in the list must follow a sequence.
  • Use variable lists when you need to include short descriptions for a list of topics.
  • Use a complete sentence that ends with a colon to introduce a list.
  • Use a list to put information into context.
  • Do not continue an introductory sentence after the list.
  • Do not connect list items with conjunctions such as "and" or "or".
  • Begin each list item with the same part of speech. For example, in a numbered list begin each list item with a verb.
  • Capitalize the first word of each list item.
  • Use a period at the end of each list item, if one of the items is a complete sentence.
  • Do not use a period at the end of each list item, if the items are phrases, words, or sentence fragments.

2.5.2. Writing Unnumbered Lists

Use unnumbered lists where the sequence of the information is not important. In addition to the general guidelines listed above, use the following guidelines for writing unnumbered lists:

  • Ensure that all list entries are similar in value.

  • Where appropriate use a sublist or nested list to further break out a complex list entry. For example:

    • Main list entry

      • Sublist entry
      • Sublist entry

    • Main list entry

2.5.3. Writing Numbered Lists

Use numbered lists where the sequence of the information is important. For example, use numbered lists for procedures. In addition to the general guidelines listed above, use the following guidelines for writing numbered lists:

  • Only use numbered lists where there are more than two items in the list.

  • For procedures, use the following guidelines:

    • Use a complete sentence with a period for each step.

    • Use a separate step for each action. However, if actions include routine substeps, you can include the substep in the main action. For example, if a step requires the user to press Return at the end of the step, you can include "then press Return" at the end of the step.

    • Where possible begin each step with an active verb in the imperative form. For example:

      1. Choose File ▸ Open.
      2. Select the file you want to open, then click OK.

  • Use clear and concise text in each step. Avoid redundant words.

2.5.4. Writing Variable Lists

You can use a variable list to separate terms from descriptions of the terms, in a list of terms. For example:

The dialog contains the following elements:

Use Proxy check box

Select this option to ...

Username text box

Use this text box to ...

Password text box

Use this text box to ...

Graphics Cross-References

About