Content of steps

Last Updated : Nov 11, 2022 |

After the conceptual information, add steps which describe how to perform the procedure.

Each step contains an action that the user performs. Do not make background information a step or describe results as a step.

Ensure that the cmd tag in a step contains one sentence. You can add an info tag to provide additional information about the step. Keep this information brief and concise.

Describe the purpose of the procedure in the context. Unless you need to provide additional clarification, most steps do not include a purpose statement.

When writing a step, start with the information that is most important to users. Typically, users need navigational or location information before they can perform an action. Tell the user where to perform an action before describing the action.

Preferred

Discouraged

On the main menu, click Set LAN Security.

Click Set LAN Security on the main menu.

In the Name field, select the port name.

Select the port name in the Name field.

In general, limit each step to a single action. You can combine two short steps in which the actions are closely related and performed within the same area.

Example

Click Save As and then type the name of the file.