1. Standard Manual Content and Bookmarked PDF’s Dr. Lam TECM 4250

2. Your Requirements Front matter - title page, table of contents, executive summary/abstract. Body matter - the 3,500 - 4,000 word technical manual. The following elements are the minimum requirements of the manual: Task Overview - Provide some reference point for readers. Create a context in some sort of introductory section that will help readers understand the general logic behind the system or process that you are documenting. Instruction Set - The center point of manual is an instruction set that readers may follow to complete one or more tasks. Appropriate Graphics - Include graphics that are appropriate to your task, audience, work environment, and that you can produce. Troubleshooting - In case something goes wrong, provide readers with assistance for troubleshooting; this may be a separate section of the document, or it may be integrated into the instructions themselves. Warnings/Precautions - Provide readers with some sense of how to protect themselves, their property, their work; like the troubleshooting information, this may be a separate section of the document, or it may be integrated into the instructions themselves. Back matter - appendices and list of references.

3. Front Matter Title Page Manual Title You or your organization’s name Visual Element TOC Must include links and page numbers Must include visual design (easily distinguishable chapter titles, level 1 headings, level 2 headings, etc.) Do not include every single heading if you’ve got too many levels. Summary/Abstract Include a overview of the overarching task (what will the manual teach a reader?) Include an overview of the audience (who – specifically – will this manual be useful for?)

4. Troubleshooting Troubleshooting can be at the very end of the manual or at the end of each pertinent section. Troubleshooting is reactive What can a user do after something inevitably goes wrong? The best way to realistically predict when something goes wrong is…???

5. Warnings/Precautions Warnings/Precautions are proactive What can a user do to avoid task failure? Ethical obligation to discuss safety or legal warnings. BUT, warnings/precautions are ANYTHING that would help a user avoid task failure The best way to realistically predict when a warning is necessary…???

6. Back Matter Appendices – any additional material that a user would benefit from but is not essential to the completion of tasks. It could include: What kinds of appendix info is included in the following manuals? http://www.mbl.edu/jbpc/files/2014/05/Storm_User_ Manual.pdf http://www.mbl.edu/jbpc/files/2014/05/Storm_User_ Manual.pdf http://cbcdn1.gp- static.com/uploads/product_manual/file/490/UM_H4 Black_ENG_REVD_WEB.pdf http://cbcdn1.gp- static.com/uploads/product_manual/file/490/UM_H4 Black_ENG_REVD_WEB.pdf http://www.wdc.com/wdproducts/library/UM/ENG/ 4779-705103.pdf http://www.wdc.com/wdproducts/library/UM/ENG/ 4779-705103.pdf

7. References Pick a reference style and be consistent Check Purdue OWL for guidelines on reference styles

8. Bookmarked PDF Can be done in Microsoft Word, but it seems complicated Can more easily be done in Adobe Acrobat Professional Let’s walk through an example