02 Elements of a procedures manual

A procedures manual typically includes the following elements:
  • Unique name, version, and publication date
  • Standardized page or screen layout and formatting
  • Standardized page numbering scheme (print format) and chapter/section/topic naming scheme (print and electronic formats)
  • Table of contents
  • Introduction and explanation of who this manual is for and where other information is available
  • Procedures organized in some logical fashion (e.g. by function group [cataloguing procedures, overnight runs, circulation reports, etc.], in order of performance, alphabetically by name, etc.)
  • Index or other search tools
In practice, a procedures manual often becomes a junk drawer for all types of documentation of questionable usefulness and reliability. 'Just put it somewhere in the Procedures Manual' becomes the lazy solution to identifying what and where information should go. While it may work in the short term, it builds up trouble for the future – especially if and when the manual is reviewed, updated or revised.


DOCUMENTING PROCEDURES 02: Elements of a procedures manual

No comments:

Post a Comment