Writing step-by-stride instructions

  • Article
  • 2 minutes to read

Follow these guidelines to assist you create clear, easy-to-follow instructions, whether y'all're writing simple, single-stride procedures or circuitous procedures that consist of multiple steps.

See also
Formatting text in instructions
Formatting punctuation

Complex procedures

Circuitous instructions oftentimes consist of multiple steps formatted as a numbered list. For multiple-footstep procedures in numbered lists:

  • Format procedures consistently so customers can find them easily by scanning.

  • Consider using a heading to help customers find instructions apace. Utilize the heading to tell customers what the instructions will help them practise.
    Examples
    To add an account
    Add an account

    Choose one phrasing style for the headings, and write them withal way (in parallel structure).

  • Use a separate numbered entry for each pace. It's OK to combine curt steps that occur in the same place in the UI.

  • Almost of the time, include actions that finalize a step, such as OK or Employ buttons.

  • Utilise complete sentences.

  • Use imperative verb forms. In instructions, customers really want you to tell them what to practice.

  • Use consequent sentence structures. For example, always use a phrase when you need to tell the client where to start. The residuum of the fourth dimension, start each judgement with a verb.
    Examples
    On the ribbon, get to the Pattern tab.
    Open up Photos.
    For Alignment, choose Left.

  • Capitalize the first give-and-take in each pace.

  • Apply a period after each step.
    Exception
    When instructing customers to type input that doesn't include stop punctuation, don't utilize a catamenia. Try to format the text so that the user input appears on a new line.

  • Limit a procedure to seven steps, and preferably fewer. Try to fit all the steps on the same screen.
    Examples

    To create a group of tiles

    1. On the Start screen, select the tiles you want to grouping together.
    2. Drag them to an open space. When a gray bar appears behind them, release the tiles to create the new grouping.

    To schedule sprints

    1. In the Backlogs view, select the commencement dart under Current. Or, open up your sprint backlog from the following URL: https://AccountName/DefaultCollection/TeamProjectName/_backlogs/iteration
      Several predefined sprints are listed under Current and Futurity. Actual sprint titles vary based on the process template used to create your squad project. Nevertheless, agenda dates haven't been assigned.
    2. To set the agenda dates, select the starting time sprint under Electric current, and select dates.

Single-step procedures

If you're using a consistent format for step-by-step instructions, use the same format for single-stride instructions, but replace the number with a bullet.
Example
To motion a group of tiles

  • On the Start screen, zoom out and elevate the grouping where you desire.

Tips for writing steps

Make sure the customer knows where the action should take place before you describe the action.

  • If the instruction appears in the same UI where the action occurs, it's usually not necessary to provide location details.

  • If you demand to brand sure the customer begins in the right place, provide a brief phrase at the first of the footstep.
    Instance
    On the Design tab, select Header Row.

  • If at that place's a chance of confusion, provide an introductory step.
    Instance
    On the ribbon, get to the Blueprint tab.

Simple instructions with correct angle brackets

Abbreviate simple sequences by using correct angle brackets. Include a space before and afterward each bracket, and don't brand the brackets bold.

Example
Select Accounts > Other accounts > Add an account.

Accessibility tip Screen readers may skip over brackets and read instructions such as Menu > Go To > Folders as Menu Get To Folders, which might confuse customers. Bank check with an accessibility practiced earlier using this approach.