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

Slides:



Advertisements
Similar presentations
Create Your Own Instruction Manual. Objectives Create an instruction manual, step-by-step guide to perform a task or project. Create an instruction manual,
Advertisements

Criteria for writing a user manual User manual components
Eight Steps To Creating Accessible Microsoft Word Documents
Microsoft ® Office Word 2007 Training Table of Contents I: Create an automatic TOC Neeginan Institute of Applied Technology GTR&O presents:
A guide into writing user guides
Welcome to... A Game of X’s and O’s Modified from a game Developed by Presentation © All rights Reserved
California State University Fullerton Campus Information Technology Training Timothy Benbow EIGHT ESSENTIALS FOR CREATING ACCESSIBLE PDF DOCUMENTS.
Basic Accessible PDF Document Training Adobe Acrobat Professional 11.
Accessible PDF Creation using Adobe Acrobat Professional 11.
Document Design Customized & Workplace Training AAI/Portland Community College Facilitated by George Knox.
Technical Writing II Acknowledgement: –This lecture notes are based on many on-line documents. –I would like to thank these authors who make the documents.
Grant Writing Diane S. Kukich, MA Dept. of Civil & Environmental Engineering University of Delaware October 25, 2005.
EE x12 Technical Reports Writing Lecture 1 Dr. Essam Sourour Faculty of Engineering Alexandria University 1.
Common Page Design. Graphics and Tables Uses: Objects Numbers Concepts Words.
PDFs & Dorsetforyou.com Laura Hall Senior Website Officer
Collaborative Report Writing the Proposal. Definition Proposal: a document written to convince your audience to adopt an idea, a product, or a service.
Accessibility Standards. This PowerPoint will cover: – Web accessibility standards – Word file accessibility – PDF accessibility – PowerPoint accessibility.
PROCESS MANUAL PROCESS MANUAL Teaching Someone to do Something.
CHAPTER 14 WRITING AND PRESENTING THE SYSTEMS PROPOSAL.
© 2012 Cengage Learning. All Rights Reserved. May not be scanned, copied or duplicated, or posted to a publicly accessible website, in whole or in part.
Dobrin / Keller / Weisser : Technical Communication in the Twenty-First Century. © 2008 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
Manuals, Instructions, and Guides (oh my!) The Different Documents  Instructions  Help reader perform a specific task  Process Instructions  Narrative.
© 2010 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 13 Instructions and Procedures Strategies for Technical Communication in the.
Chapter 14. Writing Definitions, Descriptions, and Instructions © 2013 by Bedford/St. Martin's1 What are definitions, descriptions, and instructions? A.
Document Supplements: All the Parts of “Large” Documents Dr. Jennifer L. Bowie Document Design Some information from Lannon.
© Prentice Hall, 2007 Business Communication Essentials, 3eChapter Writing and Completing Reports and Proposals.
Formal Report Organization Engl 3365 Copyright 2012 by Art Fricke.
FEASIBILITY REPORTS WHAT IS A FEASIBILITY REPORT? A feasibility report assesses if an idea or plan is practical based on specific criteria. Variety of.
Writing and Editing Modular Documentation: Some Best Practices Yoel Strimling (Comverse) Based on a joint presentation with Michelle Corbin (IBM) at the.
© 2008 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 22 Instructions and Procedures Technical Communication, 11 th Edition John.
Topic-based Authoring/ Technology Options for Building a Knowledge Base TECM 4180 Dr. Lam.
The Assignment says: Present your analysis of the data in a written form directed to an audience you think appropriate.
15 The Research Report.
Goals of Documentation ITSW 1410, Presentation Media Software Instructor: Glenda H. Easter.
Introduction to Technical Manuals TECM 4250 Dr. Lam.
PROCESS MANUAL PROCESS MANUAL Teaching Someone to do Something.
TABLE OF CONTENTS 2014 BasmahAlQadheeb. What is a report? A report is a clearly structured document that presents information as clearly as possible.
1 Technical Communication A Reader-Centred Approach First Canadian Edition Paul V. Anderson Kerry Surman
Accessible Word Document Creation Using Microsoft Word 2010.
Chapter 19: “Writing Instructions and Manuals” Matthew Frase.
Accessible PDF Creation using Adobe Acrobat Professional 11.
Topic-based Authoring and Structured Authoring TECM 5191 Dr. Lam.
© 2005 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 22 Instructions and Procedures Technical Communication, 10/e John M. Lannon.
TECM 4180 Dr. Lam.  What a knowledge base is…  How to conduct interviews…  The difference between data, information, and knowledge…  What information.
Dobrin / Weisser / Keller: Technical Communication in the Twenty-First Century. © 2010 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
THE FORMAL REPORT THE FORMAL REPORT. Definition and Purpose Definition: reports formatted in a professional way to emphasize its importance or recommendations.
Convert a Word Document to PDF File With Bookmarks UNDP - POGAR Training and Support Document Required software: 1.MS Word Adobe Acrobat Professional.
“Copyright and Terms of Service Copyright © Texas Education Agency. The materials found on this website are copyrighted © and trademarked ™ as the property.
Instruction Set ENGL 202C. CONTENTS Depending on the nature of your task, you may wish to include some or all of the following contents. Introduction.
CYPS – Foundation Degree How to write a report
Instructions and Procedures
Technical Report Writing
Effective Presentations
Technical Manual Writing and Content
Creating Accessible PDFs from Word Docs
Front Matter and End Matter in Long Documents
Creating Accessible Electronic Content
Basics of Accessibility in Adobe PDF
Creating Reader-Centered Graphics
Microsoft® Office Word 2007 Training
Giving instructions on how to do something
TECHNICAL WRITING – THE BLENDED LEARNING INITIATIVE
Chapter 21 Formal Reports
Writing reports Wrea Mohammed
Teaching Someone to do Something
Writing an Engineering Report (Formal Reports)
Chapter 17 Technical Instructions
Designing Pages and Documents
Public Relations and New Media Richard Bailey
Teaching Someone to do Something
Presentation transcript:

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

Your Requirements Front matter - title page, table of contents, executive summary/abstract. Body matter - the 3, ,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.

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?)

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…???

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…???

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? Manual.pdf Manual.pdf static.com/uploads/product_manual/file/490/UM_H4 Black_ENG_REVD_WEB.pdf static.com/uploads/product_manual/file/490/UM_H4 Black_ENG_REVD_WEB.pdf pdf pdf

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

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