Example of a Before and After Document

Last year I attended an interview for a technical writer role. Nothing came of it.  As part of the application process,  I was tasked with taking a provided “document” and rewriting it into something suitable for a scientific environment.   I retain the copyright to this rewritten instruction.

Here is the before version:

Tube Sealers – Preventative Maintenance & Inspection

Ongoing checks of tube sealers are not required due to 100% inspection of seals by staff during general use.

The T-SEAL II has an LED error indicator at the top front of the unit. If LED is RED refer to the Operating Manual.

If recommended by the manufacturer, tube sealers should be serviced annually by an approved service provider.

NOTE: The manufacturers of the following tube sealers state that there is no preventative maintenance requirement: –

Terumo Heat Sealers, including:

  • *T Seal II (bench top tube sealer)
  • *LM100E (hand held tube sealer)
  • *ACS152 (bench top tube sealer)
  • *AC155 (bench top tube sealer)
  • *XS1010 (bench top tube sealer)

CompoSeal Universal (bench top tube sealer)

Mobilea (hand held tube sealer)

An external service report is provided. The functional area manager / delegate check, sign & date the report file with departmental records.

Record that this service has been completed on Equipment Maintenance Record or equivalent. Ensure a label is affixed to the equipment indicating date of service and next due date for service. NOTE: For some heat sealers (e.g. JMS) it is recommended that spare batteries are available in the event that battery replacement is required. When changed by the service personnel, record the event on Equipment Maintenance Record or equivalent. Complete an annual electrical test and tag as per Electrical Safety Procedure. If faulty remove as per Tag Out Procedure.

The following link is to the “after document” that I submitted to the organisation: TW_Test_August_2013_redacted (pdf).

Did you find this informative or useful? Please consider a small donation so I can expand and improve on what I deliver.