Introduction to Technical Manuals TECM 4250 Dr. Lam

Let’s Recap (again) Week 1 - Visual Design CRAP Memo Genre Week 2 – Comparative analysis Creating effective criteria Writing informal reports (including style and tone) Week 3 – process description Information literacy and “just in time” research Structure of a process description Catering your content to multiple audiences Audience analysis

Reflect For each week, write down at least 2 applicable and tangible lessons for which you can apply to future projects and/or writing.

Today’s Goals 1.Choose a topic 2.Have a general framework for technical manuals

Rest of the Semester 1.Task analysis 2.Graphics and screen shots 3.Writing instructions and task overviews 4.Content reuse 5.Front and back matter

Project 4 Technical Manual – Website says that it must be a bookmarked PDF. You also have the option to create online help. Must be an instructional manual focused on the completion of a task Must be technical (see next slide) It can be documented, but it must not be well documented E.g., How to use styles in Word, How to create a manual in InDesign.

Let’s start by eliminating topics Non-technical topics How to make a pb & j sandwich How to tie shoes Overly Documented Topics How to use styles in Word How to create a manual in InDesign Topics that are too general How to use Wordpress How to use an Android Phone Topics that are too specific How to create a navigation bar in HTML How to uninstall software from your Mac.

Example from Hobby A Primer for Pour Over Coffee Introduction: Different Pour over options Procedure 1: How to choose an option Procedure 2: How to grind the beans properly Procedure 3: How to brew the perfect cup Troubleshooting (e.g., Cup too strong, cup too weak, etc.)

Let’s Brainstorm Topics Write down as many hobbies/interests/discipline you have Write down as many systems or processes that are involved in your hobbies/interests/disciplines Choose three options that you can write 3,500-4,000 words on

What should be included? Front Matter Title Page TOC Executive Summary/Abstract Body Matter (3,500-4,000) Task overview Instruction set for 1 or more tasks Graphics Troubleshooting Warnings/Precautions Back Matter

urrent/users/index.html urrent/users/index.html m/chap01/01-04_online.htm m/chap01/01-04_online.htm MA1714/en_US/macbook_pro_retina_15_inch_mid _2015_essentials.pdf MA1714/en_US/macbook_pro_retina_15_inch_mid _2015_essentials.pdf wss.com/gds/6/ /03/PSG11_CUG_EN _03.pdf wss.com/gds/6/ /03/PSG11_CUG_EN _03.pdf

Manual Analysis For each manual: 1.Describe and evaluate how each manual adheres to the required sections of a manual. 2.Describe and evaluate the navigation and user experience. 3.Note the writing style and tone. 4.Describe and evaluate the visual design. 5.Rank the four manuals from best to worst.