Preparing Manuals

50 %
50 %
Information about Preparing Manuals
Education

Published on July 31, 2009

Author: jericm

Source: authorstream.com

Preparing Manuals : Preparing Manuals English 323: Technical Writing Step One : Step One Determining your audience: language and technical detail must fit intender user Layperson Skilled technician Step Two : Step Two Consulting the experts: research by talking to the designer, engineer, etc. How the product works What are the instructions and warnings How many details to include (especially to suit different audiences) Step Three : Step Three Writing the manual Space consideration Features and highlighters: headings, lists, numbering system, headers/footers Table of contents, glossary, appendices Tips and safety considerations Copyright data Every little detail Step Four : Step Four Preparing graphics and visuals Photos? Line art? Drawings? Exploded? Cutaway? Schematics? Print type and size? Lists of items Color (used sparingly in manuals) Cautions and warnings and tips icons Miscellaneous Tips : Miscellaneous Tips Begin each step with a verb Use highlighting techniques Limit information within each step Develop points thoroughly. Don’t assume that your audience will understand simple or missing steps. Example: If you are telling someone how to make a PB&J and you say put the peanut butter on the bread, you are not telling them how to accomplish the step because there are steps within that single step such as dipping the peanut butter out of the jar with a utensil, holding a piece of bread in one hand while apply the peanut butter, etc. Use short words and phrases Do not use recipe language (leaving out « the » and « an ») Step Five : Step Five Deciding on production and supplements Orientation of paper, paper quality, the number of manuals to be printed Pagination, section tabs, reference bands, warranty, inclusions The Parts of the Manual : The Parts of the Manual Table of Contents Introduction: state the message such as « This set of directions is ….  » Support: list of materials, tools, safety issues Body: explain the process, the steps Closure: conclude your manual with a sentence such as « Congratulations, you have uploaded the software. » Supplemental sections: glossary, appendix, etc. Defining Terms : Defining Terms Audience: Words have more than one meaning, often depending on who you are writing for or talking to. ‘tongue’ linguist > language, speech biologist > muscle in the mouth cobbler > part of a shoe religious group > communication with God Defining Terms : Defining Terms Methods Parenthetical expressions Brief phrase Formal : name of term + class of term + character of term Example – A tongue is a flap of material under the laces of a shoe or boot. Create a Manual: Objectives : Create a Manual: Objectives In creating an instructional document, the student will do the following: apply the rules, directions, and concepts of writing a manual. research information to include in a set of instructions explain the steps in performing a task and working with a set of materials. design and lay out a manual. Create a Manual: Directions : Create a Manual: Directions Choose a task with at least four steps but fewer than eight steps that you know how to successfully accomplish. The task should be one that someone in your field must be able to perform, such as preparing a gram stain or detecting child abuse. Follow the steps in this slideshow to create your manual. Collaborate on this project using a wiki in Moodle. Create a Manual: Evaluation : Create a Manual: Evaluation I will grade this assignment on the following criteria

Add a comment

Related presentations

Related pages

Writing Revisable Manuals > Preparing Specifications for ...

2 Development Process Preparing Specifications for the Manual. The next step is to prepare specifications for the manual. This is the equivalent of the ...
Read more

PHP: PDO::prepare - Manual

PDO::prepare (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0) PDO::prepare — Prepares a statement for execution and returns a statement object
Read more

Preparing a Procedure Manual -- CLIA - Home | American ...

Find out how to prepare a lab procedure manual that will document processes, train new personnel, troubleshoot problems and measure performance.
Read more

PREPARING A PROJECT MANUAL - AIA Austin |

PREPARING A PROJECT MANUAL An Overview Presented by Larry Alan Whitlock, AIA, CSI/CCS/CCCA, NCARB AIA Austin Summer Conference & Product Expo
Read more

Preparing a Computer for Manual Driver Deployment

You can deploy a driver automatically or manually. In either case, you need to prepare the target computer first. Here we describe how to prepare the ...
Read more

How to Prepare Training Manuals | eHow

How to Prepare Training Manuals. The increase in web-based training, webinars and on-line training has increased the need for clear, easy-to-follow, visual ...
Read more

Preparing a house manual - Lynda.com: Online Video ...

Preparing a house manual provides you with in-depth training on Business. Taught by Christopher Matthew Spencer as part of the Making Money with Airbnb
Read more

TEACHER MANUAL - SI: Seminaries & Institutes of Religion

PREPARING FOR AN ETERNAL MARRIAGE TEACHER MANUAL Religion 234 Prepared by the Church Educational System Published by The Church of Jesus Christ of Latter ...
Read more

PREPARING A PROJECT MANUAL - AIA Austin |

preparing a project manual larry alan whitlock, csi/ccs/ccca, aia, ncarb architectural specifications consultant (m) 512 550 5233 413 swenson farms blvd #716
Read more