Procedures
A procedure is a numbered list of sequential actions that a reader can follow to complete a task. Using consistent formatting for procedures helps users identify tasks and follow steps.
tip
For instructions on implementing this guidance with Markdown, refer to Confluence: Formatting documentation.
To write a procedure, follow these steps:
Precede the list with a stem clause, such as the one above, that begins with "To" and clearly states the outcome of the procedure. Write the stem in a separate paragraph so that it stands out from other text. Use plain text and not a heading. End the stem with a colon.
Don’t write any single-step procedures. Break it up into multiple steps, or write the step in a regular paragraph.
Limit each step to one main action. You can include a second minor action to finalize the step.
Begin the step with an action verb in the imperative form that explicitly directs the reader to do something.
If you need to qualify or orient the reader to a step, begin with an introductory clause that precedes the imperative action verb, offset with a comma. Keep this clause brief. Make sure the reader can easily find the action verb.
Follow the numbered step with any additional information and images that explain what happens when the step is carried out.
The additional information can be in one or more separate paragraphs, like this, or in the same paragraph as the step, if it is brief. Indent additional paragraphs, code snippets, and text at the same level as the numbered paragraph, so that the numbers are easily visible in a vertical line with no interruptions.
To accomplish this effect in markdown, add a tab before each unnumbered paragraph. For example:
4. This is where the step appears.
This is where you add the additional information.
5. This is the next step in the procedure.Present information in the order the reader performs the task.
Don’t create numbered sub-steps with outline numbering. Instead, consider breaking up the step into more items. It's fine to use an unordered list within a procedural step, but not for more steps.
Keep procedures as short as possible. If the procedure is too long, consider breaking it up into smaller sub-tasks.
| Incorrect | Correct |
|---|---|
Use the Keystore dropdown to load an existing keystore. First, click Select Existing and then select Browse to load a keystore from your file system, or select a keystore stored in a Dedicated Location from below the partition. Next, enter the password in Keystore password. Finally, select Load Keys. | To use the Keystore dropdown to load an existing keystore, follow these steps:
|
You can connect Unity’s profiler to a running Universal Windows Application. Perform the following steps:
| To connect the Unity profiler to a running Universal Windows Application, perform the following steps:
|
|
|
|
|
|
|
|
|