Download - Technical Instructions

Transcript
Page 1: Technical Instructions

Technical Instructions

ENGL 3100

Dr. Shelley Thomas

Page 2: Technical Instructions

Overview

• General Requirements

• Task Analysis– We’ll start them in class

• Technical Instructions – Because of the graphic-intensive nature of this

assignment, I must have a hard copy

Page 3: Technical Instructions

General Requirements

• Select a topic that has at least 3 to 5 sets of steps

• Document a technical procedure for an identifiable group that would want or need detailed instructions

• Use only original text for this assignment

Page 4: Technical Instructions

General Requirements (con’t)

• All of these documents are due with the final product:– A brief cover memo introducing the project

and its components (at least 1 page)– The task analysis– The final, printed set of instructions

Page 5: Technical Instructions

Task Analysis

• Provides a detailed outline from which to develop the document

• Clearly states the goal for each step• Provides the start state and end state for

each step– Start state – the conditions that need to exist

before the step is performed– End state – the outcome of the step

Page 6: Technical Instructions

Task Analysis (con’t)

• Graphics– Insert placeholders for appropriate graphics– Gives an indication where graphics will be

needed

Page 7: Technical Instructions

Example Task Analysis

• Topic: Checking email in Hotmail

• Audience/User: New Hotmail account holders

• Scope: Checking email (only)

• Materials: Computer with internet connection and Internet Explorer or Firefox

Page 8: Technical Instructions

Example Task Analysis (con’t)

• Goal of Step 1 (Open Browser)– User needs to access the Hotmail homepage

• Start State– User has access to a running computer with an internet

connection

• End State– User has successfully accessed the Hotmail home page

• Graphics– Screenshot of the Address line and screen shot of the

Hotmail homepage

Page 9: Technical Instructions

Example Task Analysis (con’t)

• Goal of Step 2 (Sign in)– Successfully sign in to Hotmail

• Start State– User has the Hotmail home page up

• End State– User has successfully signed in to her hotmail account

• Graphics– Screenshot (close-up or callout) of sign in

Page 10: Technical Instructions

Example Task Analysis

• Repeat the Goal, Start State, End State, and Graphics for each step within the task

Page 11: Technical Instructions

Example Step

Step 2: Sign in to Hotmail.

1) Type your Windows Live ID (see Figure 1: Sign in Screen)2) Type your password (see Figure 1: Sign in Screen)3) Press “Enter” or click the Sign in button to access your email account

NOTE: Passwords are case sensitive. JSmith is not the same as jsmith

Figure 1: Sign in Screen

Page 12: Technical Instructions

Format for Instructions

• Clear introduction (see Markel 506-507)

• Presented step-by-step– Numbered– Sufficient detail– Imperative mood– Appropriate graphics

• Conclusion (see Markel 508)