What to Include in Your Instruction Manual? 1. Objective Of Your Instruction Manual. The first step in creating an effective manual is to have a clear objective in mind. Answers to questions 2. Think About What You Want to Include. 3. Keep Your Readers in Mind. 4. Collaboration is Key. 5. Get Estimated Reading Time: 9 mins. · Use an active tone of voice when writing instructions. Keep it short and to the point. Use a clear visual to illustrate the step. Split up a task in several different sub-tasks. Separate all additional information in icons (warnings - tips - alternative routes - error fixes). Share it .
Follow these simple steps when creating digital work instructions: Structure your work instructions in a clear, step-by-step instruction hierarchy. (guide - topic - instruction - step). Use an active tone of voice when writing instructions. Keep it short and to the point. Use a clear visual to illustrate the step. The manual writers should be a part of the design team. Ideally, the manual is written first, aimed at being short, simple, and understandable. The designers and engineers help oversee the writing, for when the manual is complete, it will serve as the product specifications that they will follow. Therefore, they must buy into the design from. 5. Gather your supplies. Have the items that you're describing on hand and ready to use as described in the manual. If you're making a paper box, have paper, scissors, tape, glue, and a ruler handy. If you're writing about a camera, make sure your camera is disassembled.
Explain the problem you want to solve, present the solution, and then outline the instructions in order to attain the solution. It may sound obvious, but these are the three basic building blocks to any good user manual. 3. Break it Down. If the problem addressed in the manual is particularly complex, break it down into smaller parts. Generally speaking, the following process should be followed to create compliant user manuals: Identify legislation (laws/directives); Identify standards; Identify requirements of the legislation and standards that apply to your product; Add legal content to the instruction manual. Being wordy just to add content and to make the manual longer is never recommended. If a procedure can be answered in just a few sentences then it is best to leave it that way. Be brief by getting to the point and answering all important items that need to be addressed. State the details, but make every word count.
0コメント