Sample procedure
This is a sample procedure, showing the various types of steps, and some with learning notes.
| # | Part | Description |
|---|---|---|
| 1 | Objective | What the step is to achieve. Best with active voice as a command of form: verb what |
| 2 | Actions | Physical actions to be done. Best with active voice |
| 3 | Response | What the system does in reponse to the actions. Best with passive voice |
Actions and responses can contain any of the basic blocks, like paragraphs, figures, lists and tables, but not special blocks like asides.
| # | Mode | Description |
|---|---|---|
| 1 | Compact | Provides just the objective lines, and is for those that are familiar with the procedure, but just need the prompts to make sure they do all steps |
| 2 | Normal | Suitable for most users, providing the full steps, but with no explanations. It is the default |
| 3 | Learning | As for normal, but with explanatory notes for the actions and responses, where required |
Actions and responses can contain any of the basic blocks, like paragraphs, figures, lists and tables, but not special blocks like asides. Each step and substep has a checkbox that controls the exposure of its actions and responses, allowing looking at the details of a particular step if the compact mode is selected.
Notes for step actions and responses can contain any of the basic blocks, like paragraphs, figures, lists and tables, but not special blocks like asides. Notes come after the main blocks of the step action or response, and their exposure is controlled by another checkbox for the step. Links to another procedure will open it with the same mode as the current page.
There is also the option to specify what roles are involved in the procedure. If there are multiple roles involved, then each step has its own roles shown against it. Not available for substeps as they are all expected to be performed by the same roles.
Steps
△☰ Indicates the step has learning notes. Click its checkbox to show them.
The roles to perform this procedure are:
by clicking the
This is the learning notes for these actions.
Actions should start with by
to indicate that they continue and qualify the objective.
This is the learning notes for this response.
Responses are what happens due to the actions. In this case, it is using the figure block to show what is displayed.
Note that when providing pictures, try to minimise the amount of dead space shown, by minimising the window size and reducing empty spaces to a representative amount, either by adjusting them directly, or editing the screen capture picture.
The point is that it is recognisable, but it doesn't have to be exactly as the reader will see it, as long as it includes the elements that are referenced in the next step, so that the reader can find them.
This is an example of providing multiple actions, using a list. Generally, only use a list when all the alternatives produce the same response.
The file is closed, without saving.
by performing:
by doing what it takes.
The actions for a step with sub-steps is set to by performing:
A
The maximum number of
The response happens.
by doing what it takes.
The response happens.
by performing the steps of: Sample procedure.
You end up back here.
Here the step links to another procedure. When clicked on, the target procedure will have a link at the bottom that returns to the source procedure. These can be up to 10 deep.
In the final