To main heading

Smallsite Design

Online visitor help

3Procedure 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 or substep from which it was called. This can be up to 10 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◪︎ (Open)Indicates the step contains more content. Clicking on it will expose that content
g≣︎ (Notes)Indicates learning notes available for the step. Clicking on it will expose the notes
hSubstepSubstep of a step. May be up to nine
iSub-procedureLink to a sub-procedure. Can be up to 10 deep. Can also be done using a step link where the link forms the whole objective
jParent procedureLink to step of parent procedure where called from

A step can be a step, step link or substeps. A substep can be a substep or substep link.

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
aCompactOnly show the step objectives. Suitable for those familiar with the procedure, but just need a prompt
bNormalShows all except for notes. For those who need to do the procedure there and then, but may have only had training on it
cLearningShow 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 – click on the ◪︎ checkbox for the step
  3. c.Notes – click on the ≣︎ checkbox for the step.

Clicking on the ≣︎ checkbox for substeps will display the notes for all its substeps, but only if their ◪︎ checkboxes are checked.

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 whole objective in a step link or substep link, or in an 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 lower-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, like:
Sample return to procedure link

This process can occur up to 10 levels deep, allowing documenting company-level processes down to the instructions for a manual task. This does not apply to links to procedures on other sites.

If currently in Compact mode, clicking on a return link to a substep will force the mode of the target procedure to become Normal to allow the substep to be shown.

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

  • Common page elements
  • Glossary page
  • Subsites page
  • Contact   Glossary   Policies
  • Categories   Feed   Site map

  • This site doesn't store cookies or other files on your device when visiting public pages.
    External sites: Open in a new tab or window, and might store cookies or other files on your device. Visit them at your own risk.
    Powered by: Smallsite Design©Patanjali Sokaris