Skip to main content

Smallsite Design

Online site usage help

Procedure article

Procedure articles provide a series of steps, and can include substeps and learning notes.

Procedures can be used for anything from high-level processes to low-level instructions. Roles may be nominated as responsible for the whole procedure or just some steps in it. A step may have substeps or link to another procedure as a sub-procedure, which will then include a back-link to the step from which it was called. This can be up to nine levels deep.

The areas on the sample procedure are:
#AreaDescription
aDisplay modeHow much of each step is shown
bLinksLinks to each step
cProcedure rolesRoles that may perform steps in the procedure allocated to them. Typically only for higher level procedures
dStepProcedure step
eStep rolesRoles allowed to perform the step. Not shown if only one role for the procedure
f[Notes]Indicates learning notes available for the step. If javascript is enabled, clicking on it shows all notes for the step
gSubstepSubstep of a step. May be up to nine
hSub-procedureLink to a sub-procedure. Can be up to nine deep
iParent procedureLink to step of parent procedure where called from

Step

Steps in Smallsite Design are detailed.

The areas of a procedure step are:
Sample procedure stepabcde
where:
#AreaDescription
aObjectiveWhat the step is trying to achieve
bActionWhat physically has to be done
cAction notesLearning notes for the Action
dResponseWhat happens as a result of the Action
eResponse notesLearning notes for the Response

Display modes

The structure of the steps allows different parts to be displayed for audiences of different skill levels.

The display modes available are:
#ModeFor
1CompactOnly show the Step objectives. Suitable for those familiar with the procedure, but just need a prompt
2NormalShows all except for notes. For those who need to do the procedure there and then, but may have only had training on it
3LearningShow all, including notes. For those learning to do the procedure

The display mode can be selected by either:

  1. a.All steps – click on the mode buttons in the Steps navigation bar
  2. b.Step – if javascript is enabled in the browser, clicking the step number will cycle through each mode for that step as Compact > Normal > Learning > Compact > …
  3. c.Notes – if javascript is enabled in the browser, clicking the [Notes] in the step or substep objective line will open all the notes available under it.

Hierarchy of procedures

Sets of procedures can be nested to cater for different levels of responsibilities.

Steps can be nested by either:

  1. a.Adding up to nine substeps to a step of a procedure.
  2. b.Linking to another procedure as a sub-procedure, either by a link as the Objective or in the Action.

Sub-procedures are for when:

  1. a.There are more than nine substeps required for a step.
  2. b.Procedures may need to be used as substeps for several procedures.
  3. c.High-level procedures need to be drilled down to the instructions for performing the details of a low-level task.

When clicking on the procedure link in a step, the target procedure includes a back-link at its end to return to that step. This process can occur up to nine levels deep, allowing documenting company-level processes down to the instructions for a manual task.

Roles

Roles can be defined for who is to do all or some steps in a procedure.

Roles may be defined for:

  1. a.Departments in a inter-company or intra-company procedure.
  2. b.Teams in an inter-disciplinary procedure.
  3. c.Positions in a delegation procedure.
  4. d.Position performing all the steps of instructions for a task.
  5. e.Subsystems in mechanical or computer systems.

If there is only one role defined for a procedure, no roles are shown for individual steps. No roles are defined for substeps, as they are all expected to be completed by the role defined for the step.

Learning notes

Notes are typically for when learning, but may be used for ancillary or supportive descriptions.

When learning, the goal is to not just to learn to do the steps, but to understand why. To this end, learning is often designed to slow down execution of the steps to allow that understanding to take place. Notes provide this in Learning mode without cluttering up the procedure for when actually doing the procedure for real as efficiently as possible.


Manage         Help   Powered by: Smallsite Design©Patanjali Sokaris         art-a  3  0  2021-10-24-12-51-22