Tuesday, May 12, 2020

Writing Instructions Definition and Examples

In business writing, technical writing, and other forms of composition,  instructions are written or spoken directions for carrying out a procedure or performing a task. It is also called  instructive writing. Step-by-step instructions typically use the second-person point of view (you, your, yours). Instructions are usually conveyed in the active voice and the imperative mood: Address your audience directly. Instructions are often written in the form of a numbered list so that users can clearly recognize the sequence of the tasks. Effective instructions commonly include visual elements (such as pictures, diagrams, and flowcharts) that illustrate and clarify the text. Instructions intended for an international audience ​may rely entirely on pictures and familiar symbols. (These are called wordless instructions.) Observations and Examples Good instructions are unambiguous, understandable, complete, consistent, and efficient. (John M. Penrose, et al., Business Communication for Managers: An Advanced Approach, 5th ed. Thomson, 2004) The Lighter Side of Instructions:  Handbook for the Recently Deceased Juno:  Okay, have you been studying the manual?Adam:  Well, we tried.Juno:  The intermediate interface chapter on haunting says it all. Get them out yourselves. Its your house. Haunted houses arent easy to come by.Barbara:  Well, we dont quite get it.Juno:  I heard. Tore your faces right off. It obviously doesnt do any good to pull your heads off in front of people if they cant see you.Adam:  We should start more simply then?Juno:  Start simply, do what you know, use your talents, practice. You should have been studying those lessons since day one. (Sylvia Sidney, Alec Baldwin, and Geena Davis in  Beetlejuice, 1988) Basic Features Instructions tend to follow a consistent step-by-step pattern, whether you are describing how to make coffee or how to assemble an automobile engine. Here are the basic features of instructions: Specific and precise  titleIntroduction  with background informationList of parts, tools, and conditions requiredSequentially ordered stepsGraphicsSafety informationConclusion  that signals completion of task Sequentially ordered steps are the centerpiece of a set of instructions, and they typically take up much of the space in the document.(Richard Johnson-Sheehan, Technical Communication Today. Pearson, 2005) Checklist for Writing Instructions Use short sentences and short paragraphs.Arrange your points in logical order.Make your statements specific.Use the imperative mood.Put the most important item in each sentence at the beginning.Say one thing in each sentence.Choose your words carefully, avoiding jargon and technical terms if you can.Give an example or an analogy, if you think a statement may puzzle a reader.Check your completed draft for logic of presentation.Dont omit steps or take shortcuts. (Adapted from Writing With Precision by Jefferson D. Bates. Penguin, 2000) Helpful Hints Instructions can be either freestanding documents or part of another document. In either case, the most common error is to make them too complicated for the audience. Carefully consider the technical level of your readers. Use white space, graphics, and other design elements to make the instructions appealing. Most important, be sure to include Caution, Warning, and Danger references before the steps to which they apply.(William Sanborn Pfeiffer, Pocket Guide to Technical Communication, 4th ed. Pearson, 2007) Testing Instructions To evaluate the accuracy and clarity of a set of instructions, invite one or more individuals to follow your directions. Observe their progress to determine if all steps are completed correctly in a reasonable amount of time. Once the procedure has been completed, ask this test group to report on any problems they may have encountered and to offer recommendations for improving the instructions.

No comments:

Post a Comment

Note: Only a member of this blog may post a comment.