EGR 2000 Module 3.1

today

• Review Week 2 Homwork
• Introduce Project 2
• Guest Speaker: Dr. Joy Robinson
• Heuristic Evaluation Review
• Review Week 3 Assignments
• Manuals, Proposals, Websites?

Week 2 REview

• Overall Great Job on P1
• MEMO Lessons learned
• GANTT Chart Lessons
• Embedded images

due this week

• Heuristic Evalaution
• Manuals vs Tech Specs
• Discussion Q & A

TONIGHT - Joy Robinson

• MS, METM, PhD Tech Comm
• Northrop Grumman Manager
• Instructor/ UX Consultant
• Technical Writer
• Q & A

manuals

• A doucement that explains HOW to PERFORM at TASK, USE a PRODUCT or LEARN at TECHNOLOGY

manual types

• COOKBOOK
• TUTORIALS
• GUIDES
• REFERENCES
• NON-VERBAL MANUALS
• NOTE: No style is better than any one
• ...it depends on the situation

COMMon components

• PREFERENCES
• GLOSSARIES
• TOC - Table of Content
• INDEXES

Preferences

• What is book about?
• Who is the audience?
• How is book organized?
• How to USE the book.
• Recognize individuals and why book was written.

glossary

• a small dictionary that defines terms in text
• Keep definitions Short
• Alphabetical Order
• Parallell and Consistency
• pg 151

T.O.C.

• Chapters and Header titles
• Keep definitions Short
• Alphabetical Order
• Parallell and Consistency
• pg 153

IndexES

• WHAT would 'I' look up in the index
• Think of the BEST topics
• Takes patience
• pg 155

MS: Cookbook

• A set of 'recipes'
• A bullet list of ingredients
• A numbered list of ordered STEPS
• Keep STEPS concise
• Define SUCCESS and FAILURE

MS: Tutorials

• Handholds the reader and 'leads them through initial use
• Use for 'Beginner' Audiences
• Tutorial is a 'first impression'

MS: Guides

• for 'Intermediate and Advance' users
• Like tutorials, GUIDES are useful where 'Steps' are not obvious

Keys to success for tutorials/guides

• Empathize with users
• Provide many examples
• Include many figures,photos
• Provide background when helpful

MS: REference Manuals

• Organized materials of 'focused topics'
• 'Reminders' not 'Tutorials'
• Provide diagnostic info & examples on each page

MS: NON-Verbal Manuals

• NO WORDS
• Illustrations and Photos
• Use when audience has NO knowledge
• Skills are better learned via photos

online help Overview

• More accessible in today
• Context Sensitive VS General
• Online Help VS Traditional Manual

MS: Summary

• Does your preference indicate WHO this manual is for?
• Do you have a TOC and Index/Glossary?
• Is there a 'natural flow'?
• Is there a mix of text, images, tables, etc...i

SEEK Activity ManualS

proposals

• A written request to DO SOMETHING
• Business, Academia and Engineering fields
• DISCUSS

template of proposal

• Cover Letter
• Biography(ies)
• Abstract
• Contingency Plans
• Revolutionary Ideas

Research proposal

• Cover Sheet/Letter
• Abstract / Project Sum
• TOC
• Descriptions (significance, objective/hypothesis, designs and methods)
• Bios
• Schedules
• BUDGET

Project proposal

book proposal

• Abstract
• Biography
• List of Previous Publications
• Marketing
• Detailed Outline
• Schedule

business plan

• Front Matter
• Executive Summary
• Company
• Product
• Support

business plan

• Market
• Marketing
• Manufacturing & Distribution
• Finances
• Schedule

Small Business Administration

• https://www.sba.gov/business-guide/plan-your-business/write-your-business-p...

Small Business Administration

proposal summary

• INFORM, INSTRUCT, DIRECT
• REVIEW and REVIEW
• Great BIO (Brag)
• True BUDGET
• Contingency Plans are key

Review samples

wk3 Discussion Q1

wk3 Discussion Q2

LAB Time (Gantt Chart)

benefits

• Status of your projects
• Improved Team communcation
• Avoid resource overload
• Measure progress of projects
• Overlapping activities and task dependencies

Benefits

• Improve time mgnt
• remote team support
• accountability
• promote transparency
• Cite: ProofHub 2019

LAB Time (Memorandum)

benefits

• Quick / brief
• Internal audience
• Written record
• Less interruptive than meeting/phone

Memo vs Letter
USE, FORMAT
& CONTENT

Untitled Slide

LAB Time (MS Excel)

Q & A