Questions?
Comments?

Last updated on
8 September, 2007

Return to:

Technical Writing
with Elsie Walker

REGISTRATION:

COST, LENGTH, PREREQUISITES:

No prerequisites.

Standard course: $100 / 4 weeks. Click here to register

Extended course: $125 / 8 weeks. Click here to register
Extended course gives you two weeks to do each lesson but contains NO additional material.

For questions about this COURSE, e-mail Elsie Walker at

ewalker738juno.com

Are you a writer who is interested in finding out about a new opportunity for work? Are you inquisitive, creative, and like to teach others with your words? If so, writing user guides (how-to) manuals) may be what you're looking for! User guides are utilized by a variety of industries. These guides help employees master procedures, show them how to use computer systems, scanners, etc. User guides are read by consumers, too. If you have software that came with an easy-to-read book of instructions, then you have seen a user guide.

The goal of this course is to introduce you to the mechanics of user guide writing and give you a feel for the field of technical writing. (Don't let the word "technical writing" fool you. You don't have to be a techno wiz to get started in the user guide field. ) In this class, you'll get the chance to do a variety of homework assignments.

You'll start with a warm-up (writing directions for a simple chore), then revise a page or two in a computer system guide based on information from a source document (maintenance is usually one of the first assignments a guide writer receives). You'll learn about including the "what-to-do" in your guides as well as anticipating the "what-ifs" and addressing them. I'll talk about what goes into putting together a guide from scratch and you'll get a chance to do a case study where you write a user guide section from scratch.

In addition to the introduction to the mechanics of writing guides, I'll give an overview of the technical writing field, how the job of a technical writer/user guide writer is set-up, working as a consultant, etc. In doing this, I hope to give you a feel for this writing opportunity.

Week 1: Overview of the course
What is technical writing?

• Overview of the field
• Overview of user guide writing - what's it all about?
• Looking at a sample page from a guide and seeing what it tells the reader
• Electronic publishing as a media for user guides

Homework: We start with a warm-up. (1)Write directions for doing a common chore - tying a shoe lace or starting a car (automatic). (2) If you have a manual that came with any of your software packages, glance through it and see the kind of information it gives and how it is presented.

Week 2: The Mechanics of User Guide Writing

Reflections on last week's homework

• The 3 C's of technical/user guide writing
• Lifecycle of a user Guide/ What is maintenance?
• From blank page to distribution : Procedure involved in getting a user guide assignment out the door
• Working with source documents to get your information

Homework assignment (1) Update page (s) in a user guide from information provided by a source document. (2) Observe how cashiers in a grocery store use a scanner to ring up orders. Brainstorm ideas of what you'd want to include in a user guide section for new cashiers on using a scanner to ring up orders.

Week 3: Writing a User Guide from Scratch

• Our Case Study - The Fairfield Scanner system
  
  Introduction of Case Study
• Steps in the writing process
  
  Gathering information: Learning about the audience and their needs, learning about what you're going to write about, brainstorming ideas
  Selecting a medium to convey your message
  Planning your document
  Style/Format
  Narrative vs. straight how-to
  Outlining
  
  Drafting
  Testing
  Revising
  Editing

Homework: Students write a two-three-page user guide section based on our Fairfield Scanner case study.

Week 4: Opportunities for technical writers

• Consulting/Company employee

What is consulting all about?
Pros and Cons: Consulting vs. being a company employee
Working with consulting firms

• What's a technical writer job interview like?
• The Society of Technical Communication & what it can offer you
• Resources

Elsie Walker is a technical writer specializing in user guides. This type of technical writer takes information and translates it into easy-to-understand text for the layperson. Elsie has written user guides for Prudential Healthcare and ADP. In addition, she has consulted on a technical writing project for Honeywell International, Inc. She is a past member of the Society For Technical Communication and has been certified in Technical Writing by Brainbench.

Walker puts her public speaking skills to use as instructor of Introduction to Freelance Writing For Magazines and Introduction to Technical Writing at New Jersey's County College of Morris.