1 / 17

Instructions

Instructions. Dr. Lam TECM 4180. Superstructure. Introduction. Keep it short If you’ve determined your reader will require an introduction, here’s 8 common elements in introductions: Subject Purpose of procedure Intended readers Scope Organization Conventions Motivation Safety.

martha
Download Presentation

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. Instructions Dr. Lam TECM 4180

  2. Superstructure

  3. Introduction • Keep it short • If you’ve determined your reader will require an introduction, here’s 8 common elements in introductions: • Subject • Purpose of procedure • Intended readers • Scope • Organization • Conventions • Motivation • Safety

  4. Description of Equipment • Whether to include this will depend on the complexity of the system • Image or picture is typical • Sometimes accompanied with written description of each component

  5. Example of “Description of Equipment” section

  6. List of materials and equipment needed • Present this before the instructions • Be specific (include information about web browser requirements, operating system requirements, etc.) • You should include a list for your instructions that includes browser requirements, internet requirements, computer requirements, etc.

  7. Organizing Directions Use a hierarchical structure. To do this: • List all steps in the process • Check the list for thoroughness • Group related steps under headings • If instructions are long, shorter groups can be gathered into larger ones

  8. Organization Activity • Group the 15 steps into three groups • Create headers for each group

  9. Activity • Add an “Equipment” section to the instructions

  10. Directions Write each direction for rapid comprehension and immediate use • In each direction give readers only enough information to perform the next step • Present the steps in a list • Use the active voice and imperative mood • Highlight key words • E.g., “Click the <Return> button”

  11. Directions (Cont.) Help readers locate the next step quickly • Number the steps • Put white space between steps and sections • Give one action per step • Put step numbers in their own column

  12. Directions Within steps, distinguish actions from supporting information • Present actions before responses • Make actions stand out visually from other material • Click the “Submit” button. The customer order screen will appear.

  13. Directions (cont.) • Present branching steps clearly • Check the acidity. • If it is high, follow the procedure on page 20. • If it is low, proceed to step 7. • Tell what to do in case of a mistake or unexpected result

  14. Activity • Revise instructions to make sure each step follows the guidelines (e.g., one direction per step, active voice and imperative mood, highlight key words) • Redesign the steps to follow the guidelines (white space between steps and sections) • Distinguish action and supporting material in the steps.

  15. Images and Screen shots • Only use screenshots that support text, rather than repeat what is said in the text • Don’t use screenshots for the sole purpose of breaking up long chunks of text • Use images to show spatial relationships (e.g., where elements are in relation to one another) • To show an interface • To show what the outcome of a complex procedure will be

  16. Bad Example of Screen Shot Usage • http://www.dell.com/support/troubleshooting/us/en/19/KCS/KcsArticles/ArticleView?c=us&l=en&s=dhs&docid=DSN_179256

  17. Better Example of Screen Shot Usage • http://support.apple.com/kb/HT4236

More Related