Lists

In this article

Ordered (OL)

Use for:

  • Step-by-step procedures

  • List of elements having a specific order (for example, listing priorities)

Include an ending period if the item contains a verb.

In step-by-step procedures:

  • If there’s only one prerequisite or requirement, include it as the first step.

  • One action per item, but you can include a minor related step such as ", and then click OK".

  • When there are many ways to perform an action, always list the simplest or obvious first. Divide those ways using the OR operator on a separate line and place them in the same step.

  • In a step:

    • Start with an indication of the new context element relative to the previous step where the action must take place (for example, In the Configuration panel, …​).

      Note

      If the element is located in a zone of the product without a name, provide a self-explanatory one.

    • When there are two or more context localization elements to include, start with the most general ones then list the more specific (for example, on the Authentication tab, in the OAuth section, in the upper-right corner, …​).

    • Add related links at the end of the step in the form "(see targetLinkTitle)" if inline links are not possible.

    • If needed, add a step result description in a separate paragraph under the action.

Sub-steps:

  • Use for related actions such as all actions in a modal window.

  • Avoid more than two sub-step levels.

    Restructure the article when you have more than two sub-step levels (for example, add sections or create a new article).

  • Do not use when only one sub-element.

Unordered (UL)

An unordered list is typically a bulleted list of items:

  • Use for converting paragraphs or sentences that are enumerations of elements.

  • Precede an unordered list with an introductory sentence ending with a colon.

  • No ending period when the item does not contain a verb.