Step formatting

July 1, 2026 · View on GitHub

Guidance

Use numbered lists for sequential steps. Start each step with an imperative verb. One step = one action. Use parallel structure throughout.

Do:

Select Local Traffic > Virtual Servers.

Select Create.

Enter a name for the virtual server.

Select Finished.

Don't:

You should go to Local Traffic and then Virtual Servers.

Creating the virtual server is done by selecting Create.

Name it.

Use substeps sparingly. If you need more than two levels of nesting, restructure the procedure into multiple tasks.

Substep numbering: 1, a, i (use the third level only when absolutely necessary).

Avoid "in order to" in step text — use "to" instead.

If a step has a result the user needs to verify, include it as a separate sentence at the end of that step, not as its own step.

Do not use "click" — use "select" for all UI interactions regardless of device.