01 Elements of a procedure

A procedure is:
  • A way of proceeding, usually a mode of conducting business or a legal action
  • A series of actions performed in a specific order or manner
A documented procedure typically includes:
  • A descriptive title or access point
  • A clear sequence of actions and responses to those actions
A documented procedure may also include:
  • An account of the output or result
  • Warnings about potential problems or error conditions
  • One or more links to related topics  
'The truth is out there' (X Files)

The most critical component of any documented procedure is complete, accurate and up-to-date information. All other components – platform, organization, layout, formatting – are secondary. If you take away nothing else from this session, remember that to efficiently document procedures you must:
  • Keep the project as accurate as possible
  • Keep the project as simple as possible
  • Keep the project as short as possible

DOCUMENTING PROCEDURES 01: Elements of a procedure

No comments:

Post a Comment