1 / 23

Writing Instructions

Writing Instructions. Write complete instructions. Make right assumptions. Don’t write ambiguous instructions. Provide correct sequence for faultless operation. Test your instructions. Writing Instructions. Come up with a good layout for your instructions.

Télécharger la présentation

Writing Instructions

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript


  1. Writing Instructions • Write complete instructions. • Make right assumptions. • Don’t write ambiguous instructions. • Provide correct sequence for faultless operation. • Test your instructions.

  2. Writing Instructions • Come up with a good layout for your instructions. • Organize document in a logical sequence. • Design warnings for emphasis. • Number the instructions. • Follow imperative sentence structure. Write complete instructions.

  3. Are instructions complete? • Make wise judgments about readers’ knowledge. • Don’t leave out any (easy, insignificant) instructions.

  4. What assumptions do you make? • When using technical terms • When using familiar words in special ways • (Put yourself in readers’ frame of reference. Over familiarity may cause carelessness.)

  5. Don’t be ambiguous • Relative words Back, front, top, bottom, hot, cold, large, small Eg. Select a suitable amount of choke for the weather conditions and temperature of the engine.

  6. Don’t be ambiguous • Words with double meaning Eg. Set the temperature control to 20̊C (68̊F) and run up the transmitter to normal working. Eg. Check undercarriage locking pin. If bent, replace. Eg. Check reading of the thermocouple read-out.

  7. Don’t be ambiguous • Unusual words, or unusual usages of familiar words Eg. The battery tray should be removed from its mounting which will be found on the offside of the car on the wheel valence. Eg. After the program has been entered, the software pilot lights are displayed.

  8. Ambiguous grammar • The screw on the connections must be loosened to enable the cable to be entered. • Cooking spaghetti: Put three pints of water on the cooker--drop in spaghetti--stir.

  9. Safety Notices • Danger • Warning • Caution • Note

  10. Using Safety Notices • Choose relevant notice. • Place it appropriately. • Use appropriate symbols, colors, and other design tools.

  11. When to Use Notes • Explanations for procedures making them easy to follow • Cautions to avoid problems • Suggesting alternative ways of doing something • Affirming present conditions aren’t dangerous

  12. Wording of Danger/Warnings • Capital letters • Bold type • Different color • Simple • Clear imperative

  13. Useful Graphics for Instructions • Illustrations • Flow charts • Numbered steps • Trouble shooting charts

  14. Basic syntax • Simple imperative “Switch....” • Conditional phrase + imperative “If..., switch....” • Locating phrase + imperative “At panel B, switch....”

  15. Syntax • Close the steam valve by turning V4 clockwise, if the temperature reading is over 275̊C. • If the temperature reading is over 275 C, close the steam valve by turning V4 clockwise.

  16. Avoid negative instructions • Keeping a string of reversals in mind is difficult. Eg. Pressure must not be lowered until the temp is not less than 70̊C. • Avoid negatives for warning Eg. Do not open value G 24 until the pressure is below2.4 kg/cm

  17. Sequence of Sections • Objective, purpose • Equipment, tools, materials, condition • Background knowledge of audience • Logical organization of steps • Placement of notices • Trouble shooting charts

  18. Writing Style • Short sentences • .Present tense • .Imperative mood • .One sentence one instruction • .Instructions separated from explanation • .Active voice • .Parallelism • .Retain articles • .Precise measurement

  19. Avoid the Following • Nominalization • .Noun strings • .Wordiness • .Difficult words • .Abstract words

  20. Instructions • Readers are active participants. • .Each instructions is a piece of tool.

  21. Can We Make Instructions Motivational? • To motivate users to read and follow instructions more carefully • .To increase the appreciation of the product • .To make the instructions more communicative • .To meet the user’s wish to enjoy him/herself with the product and instructions

  22. How to Make Instructions Motivational? • Create appropriate personas • .Friend, helper, expert, nontechnical person • .Use narratives • .Testimonials • .Anecdotes • .Stories • .Examples

  23. How to Make Instructions Motivational? • Make goals attractive • Announcing what has been achieved and what else to be done • Announcing the results and advantages of certain actions and then presenting the instructions • Encourage confidence • Stories/testimonials from others • Emphasizing the doableness of tasks • Michael Steehouder and Nicole Loorbach, “How Can We Make User Instructions Motivational?” IPCC Proceedings, 2004

More Related