What information should a repair procedure include?

In the "head" section, include:

  • Title. This is the first thing people will see upon opening an electronic procedure on their mobile device or when picking up a paper one. Consider that fact when writing the title.
  • Equipment name. Unless the procedure covers types of equipment generally (e.g., sump pumps under 5 hp), it must show the name and asset number of the equipment.
  • Equipment location. Specify the building coordinates (e.g., "H-7") and try to describe its position relative to some major feature (e.g., "About 34 ft northwest of loading dock").
  • Crew needed. List titles and, where appropriate, special qualifications.
  • Degree of technical difficulty. Express in a word (e.g., "moderate") or number.
  • Estimated completion time. You might need to show a range.

These sections typically precede the actual technical steps/instructions. Include:

  • Lockout/tagout. List known energy sources, not just electrical ones, and applicable drawings.
  • Safety. Address MSDS of any chemicals present, permits required, ventilation requirements, recommended PPE, and other safety information.
  • Environmental. For example, how to dispose of old lubricants, used solvent, and old parts.

In our next issue, we'll look at five more sections a good repair procedure should include.