Gretyl's Portal

Heretto Help

Unordered and Ordered List Elements

Lists enable you to present information in an engaging and easily scannable way.

Guidelines

  • Use parallel structure when writing a bullet list. For example, start each bullet point with a verb.
  • Capitalize the first letter of each list item.
  • Include all common information from the list items in the introductory sentence to avoid repetition.
  • Do not use an ordered list to document procedures within a concept or reference topic. Instead, use a task topic.
  • Do not add a period to the end of any list item, even if the list item is a complete sentence.

    The only exception to this rule is when a list item uses more than one sentence. In this situation, you must add an end punctuation to all sentences in the list item and all items in the bullet list must also include end punctuation.

Unordered List Element

When you need to list three or more items in no particular order, use the unordered list element so the reader can quickly scan the bullet list items. Using an unordered list element prevents long lists of items from being embedded in a sentence, which is more difficult to read.

Ordered List Element

The ordered list element provides some structure so that the list items are numbered. Only use the ordered list element in a concept topic to explain a process.

Note: If there is a procedure to follow, it's typically best to use a task topic instead.

Examples

Modify the following properties:

  • Owner
  • Status
  • Date
  • Metadata

Creating and using Taxonomy Metadata requires you to:

  1. Create a taxonomy of terms
  2. Assign taxonomy to a metadata category
  3. Assign metadata to files