Technical Editing
Technicians often send me documents they've written for other technicians. This document originally was an unnumbered procedure that sprinkled basic information about the product in with the steps. In addition, the author had tagged information as warnings when they were actually just steps in the procedure.
To make the document more user-friendly, I started the document with a brief overview. I segregated basic product information and added a callouts to the main graphic. Finally, I moved the troubleshooting information into a table so it could be referenced by the type of error.
The final document was posted on the technicians knowledge base for their use.
Troubleshooting Document
