When substeps are not useful

Last Updated : Jun 26, 2023 |

Do not use substeps to:

  • Artifically keep the number of steps below a certain limit.

    It is better to use more standard steps than it is to add substeps unnecessarily.

  • Organize steps around different elements in the UI.

    Guide the customer through the UI, one area at a time. The customer can only be in one area of the interface at a time, so splitting this information up into substeps adds little value.

  • Cover multiple tasks in a single task topic.

    Where logical divisions exist, use separate topics for different tasks.

  • Branch to another series of steps on which the current task is dependent.

    For example, instead of using substeps to introduce prerequisite steps, put them in a separate topic.

Example

The following is an example of a scenario where substeps are not beneficial. This example uses substeps to branch to an additional procedure. Information about finding the Thumbprint value belongs in a separate procedure. The current procedure can include a link to that procedure.