Homework Exercise 1: Study user knowledge
List and evaluate situations requiring instructional writing; people and activities. The idea of this assignment is to identify software users and analyze it according to principles of task orientation.
Steps
- Identify three persons in a workplace situation where you know software is used.
- Phone or visit each person and conduct a brief (under 30-minute) interview.
- Ask the person to describe the kinds of software programs he or she uses in the workplace.
- Ask these questions:
Describe the job: "What are your main workplace activities (overall job description)?"
Describe the job tasks: "What are your main workplace actions (job duties and task responsibilities)?" Ask about actions that form sequential units to achieve an overall workplace goal.
Identify user knowledge: "What have you learned about a software program that wasn't taught in the manual?" "What tricks or special techniques have you developed for working with your favorite program?"
- Write a brief, one- to two-page report about your findings. Your reader is your publications manager wanting to know how would you structure a software manual or help system to support this person's work with this specific program?
Homework Exercise 2: Write a terrible procedure
Break the rules of good language in documentation. In this exercise you are to write a procedure for a task that breaks all the rules. The more rules you break the better. For help in finding what rules to break, consult WSD, Chapter 12: Getting the Language Right.
- What to write about? Select any menu of a fairly familiar program like Internet Explorer.
- The procedure should be between 5 and 10 steps long (not too long).
The trick to this exercise is to make the procedure "good/bad" so that you can show off your writing skills while making mistakes. You should focus on bad style rather than bad format. Write a parody of bad instructional prose. Have fun.
Write a brief, one-page (maximum) memo to me telling the rules you broke and why.
Homework Exercise 3: Un-design and test a document
Remove the formatting (layout and graphics) from a web page or other instructional document and test it in the un-formatted form. Describe the problems your user had with the document. Write a brief report on the difference that the layout and graphics make.
Homework Exercise 4: Take the Learning Styles Inventory and write a short report.
Visit this site: Learning Styles.
Process: read about the learning styles and predict what you think you characteristics will be. Then take the inventory and see what it says. Write a brief report (one-page memo) telling how well you think the inventory predicted your learning style as you see it.
Practice applying learning styles concepts using the Learning Styles Workshop
Homework Exercise 5: Plain Language Strategies
The link below takes you to a site devoted to writing government regulations in plain English.
Visit the site and navigate to the examples section for manuals: Manuals.
Select one of the "before" and "after" examples and study them both. Write a brief evaluation of one of them in terms of 1) compromises in cultural sensitivity you can identify, and 2) overall efficiency of the revised ("after") version.
Example: http://www.smartny.com/sm_whitepaper.pdf
B E F O R E
STANDBY MAGNETIC COMPASS
The STANDBY MAGNETIC COMPASS provides aircraft heading information. It is intended for use if a failure of both primary displays occurs.
STANDBY ATTITUDE INDICATOR./COURSE DEVIATION INDICATOR SYSTEM
The Model ADI-355 Attitude Indicator (Photo 8) provides a visual display of pitch and roll attitude and both enroute
Course Deviation Indicator (CDI)/Very High Frequency Omnirange (VOR)/Dis-tance Measuring Equipment (DME)/Flight Management System (FMS) navigation aids and precision approach Instrument Landing System (ILS) information. The indicator may be used as a long range standby attitude reference, during a primary power failure, when coupled with an emergency power supply. After complete loss of power, nine minutes of useful attitude information is presented.
A F T E R
STANDBY MAGNETIC COMPASS
The standby magnetic compass supplies information for the aircraft heading. This compass operates when there is a malfunction in the primary systems.
STANDBY ATTITUDE INDICATOR AND COURSE DEVIATION INDICATOR SYSTEM
The Attitude Indicator Model ADI-355 (see photo 8) has a display for pitch and roll. This
display also includes these indicators:
Course Deviation Indicator (CDI)
Very-High Frequency Omnirange (VOR)
Distance Measuring Equipment (DME)
Flight Management System (FMS)
Instrument Landing System (ILS)
When there is a power failure, the model ADI-355 can supply an attitude reference for the next nine minutes. After nine minutes, see the Emergency procedures.