Skip to main content

Smallsite Design

Sample procedure

This is a sample procedure, showing the three display modes that the details of steps can be shown by.

Each step consists of:
1ObjectiveWhat the step is to achieve. Best with active voice as a command of form: verb what
2ActionsPhysical actions to be done. Best with active voice
3ResponseWhat 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.

The three display modes are:
1CompactProvides 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
2NormalSuitable for most users, providing the full steps, but with no explanations. It is the default
3LearningAs for normal, but with explanatory notes for the actions and responses, where required

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.

Clicking on a step number will cycle through the modes, but just for that step. Where a step has learning notes, [Notes] is placed at the end of the objective. Click on the step number until the notes show. Note that this requires javascript, so if it is turned off, the only way to change mode is the links at the start of the article navigation bar. 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.

Steps ^

[Notes] indicates that learning notes are available for the step. Click the step number until showing.

The roles to perform this procedure are:

  1. a.Project Manager
  2. b.Team Lead.

To do some really useful thing:

1Open the Paint program  [Notes]Project Manager ^

by clicking the Paint button.

This is the learning notes for these actions. Notes can be interspersed with actions paragraphs or other blocks.

Actions should start with 'by ' to indicate that they continue and qualify the objective.

The program is displayed:
Screenshot of Paint program

This is the learning notes for this response. Notes can be interspersed with responses paragraphs or other blocks.

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 picure.

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.

2Close the file  [Notes]Project Manager, Team Lead ^

by performing one of:

  1. a.Clicking the Close button
  2. b.Selecting the File menu option, then the Close option from the resulting list
  3. c.Pressing the Ctrl+X keys.

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.

3Do something that requires a few sub-steps  [Notes]Project Manager ^

by performing:

3-1Do the first sub-step  [Notes] ^

by doing what it takes.

The actions for a step with sub-steps is set to 'by performing:'.

Sub-steps are used to group a set of related steps that achieve a sub-objective within the flow of the steps.

The maximum number of sub-steps is nine. Reference another procedure article instead if you need more than nine.

The response happens.

3-2Do the final sub-step ^

by doing what it takes.

The response happens.

4Go in a circle  [Notes]Team Lead ^

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. There can be up to nine levels of such links.

The typical uses for this step type are:

  1. a.There would be too many sub-steps (only nine allowed)
  2. b.The linked-to procedures are referenced by multiple instructions articles.

In the final notes for a procedure, perhaps provide a link to a questionnaire so that the reader gets to test what they have learnt.

English (Australia) [en-au]

English (United Kingdom) [en-gb]

English (United States) [en-us]

art-p  3  0  2014-02-05-07-00-00         Manage         Powered by: Smallsite Design©Patanjali Sokaris