How To Write a User Manual: An Introduction to Technical Writing

I am honored and excited to be teaching an introductory course on Technical Writing at Temple University in Center City, Philadelphia

How To Write a User Manual: An Introduction to Technical Writing
We have all been stumped when confronted by unclear procedures in a sloppily written user manual. Rectify this by learning to write clear instructions to produce a usable user manual for any product or process you care about. Avi Solomon, an experienced writer in the high tech industry, will lead you through a reliable, systematic method of technical writing to help you learn to design, write, edit and produce a practical user manual on a topic of your choice.

Session 1: What is Technical Writing?
Introducing Technical Writing, bad vs. good instructions, helping users kick ass!
Exhibit: Haynes Car Manual, Apollo Rocket Manual.

Session 2: How to Write a User Manual: A Systematic Method of Technical Writing
The nuts and bolts of a simple, effective method to write and produce effective user manuals for almost anything. The method consists of the following stages: Research, Task Analysis, Outline, Storyboard, Draft, Edit, Produce.
Exercise: Bring a Product or choose a Process you wish to write a User Manual for.

Session 3: Researching the User Manual
Enlist anthropological fieldwork to your aid, how to work with experts and users, recording data.
Exercise: Conducting Fieldwork.

Session 4: Task Analysis: Mapping the User:Task Matrix
How to organize and analyze the research data into a User:Task Matrix.
Exercise: Creating a User:Task Matrix Table.

Session 5: Outlining the User Manual
How to make an outline of your user manual.
Exercise: Outline your User Manual.

Session 6: Storyboard the User Manual
Storyboarding as a powerful writing tool, storyboard review and feedback.
Exercise: Storyboard your User Manual and conduct a Storyboard Review.

Session 7: Draft the Topics
How to write a procedure, integrating text and visuals.
Exercise: Draft your Topics

Session 8: Editing the User Manual
How to edit your user manual with fresh eyes.
Exercise: Edit your User Manual.

Session 9: Producing the User Manual
Using single sourcing to produce your manual in different output formats.
Exercise: Produce your User Manual.

Session 10: Student Presentations & Conclusion
Each student will present their user manual for critique, next steps in technical writing.

Join the Technical Writing course group on Facebook