Punctuation in procedures

Last Updated : Nov 11, 2022 |

In general, add a period after each step. Rewrite the step if it contains a command or input-sensitive text that the user will copy. A command will fail if it contains an extra period or any kind of typo.

Rewrite the step so the command is not at the end. Alternatively, add a codeblock element under the step. The codeblock element is especially useful for long commands.

Examples

  1. Run the ccmNetSetup command to configure the FQDN.

  2. Run the following command:

    agn ccm-upgrade load -d /var/avaya/artifactCache/downloads -h ccm.server.example.com