Course overview and objectives
Grades
Textbooks
Resources
Online textbook
TECHWR-L mailing list archive
TECHWR-L articles
Policies
Course evaluation

This course—along with Technical Communication: The Profession, Writing Style, and Format, Technical Reports for Industry, Government, and Business, Advanced Technical Communication: Recent Developments, Advanced Projects in Technical Communication, Career as a Lead Technical Writer—is available from JER Online. This and the first two courses listed here are ready and available now. The last three courses listed here will be ready end of August 2017.

This view of the course does not include links to the individual units.

Course owner: your_name
Course instructor: instructor_name
Instructor e-mail: instructor_email
Course start date: mmddyy

In User Documentation for Technology Products, you study and practice task orientation which is critical to good user-oriented documents, review writing styles common in user documentation, especially passive voice, write two sets of instructions, the second of which you create and apply a template with customized character and paragraph styles, create properly written and formatted standard operating procedures, study the design and components of user guides, and create a beautiful user guide of your own.

When you complete a unit, click the Completed button for that unit. If you mistakenly mark a unit as completed, contact your instructor (or just wait until you've actually completed it.)

Getting Started

Please read the overview of this course to learn how it works and what the requirements are. Make sure that you understand the objectives of this course, the schedule of activities, the methods of operation, and the assessment of your work.

Due date: mmddyy

Unit 1: Task Orientation

For this unit:

  1. Use the task_orientation study guide to learn about and practice the concept of task orientation.
  2. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Unit 2: Passive Voice and Other Writing Style Issues

In this unit:

  1. Use the study guides for passive voice and other writing style issues to ensure that you can recognize and revise problematic instances of the passive voice. This unit also includes a review of writing style choice such as imperative, declarative, and second-person.
  2. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Unit 3: Brief Instructions 1

In this unit:

  1. Use the study guide for instructions to plan and write your first shot at instructions.
  2. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Unit 4: Formatting Reference Information

In this unit:

  1. Use the study guide for formatting reference information to format reference information (such as an API, command or subroutine).
  2. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Unit 5: Brief Instructions 2

For this unit:

  1. If you have not done so already, use the study guide for character and paragraph styles to to learn about or review using character and paragraph style to improve your effiiciency and consistency in writing technical and business documents.
  2. Use the study guide for instructions to plan and write your second shot at instructions. In these instructions, create and use your own character and paragraph styles.
  3. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Unit 6: Standard Operating Procedures (Formatting)

For this unit:

  1. Use the study guide for standard operating procedures to learn about or review standard operating procedures (SOPs) and reformat instructions you have written in a previous unit.
  2. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Unit 7: Components of Standard User Guides

In this unit:

  1. Use the study guide for user guide components to learn about or review user guides and construct one from unformatted text and graphics.
  2. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Unit 8: Final Project: User Guide for a Technology Product

In this unit:

  1. Use the study guide for user guide development to plan and write your own industry-standard user guide.
  2. Introduction to Print Outputs for Technical Content. Yehoshua Paul, June 2013, TechWhirl.
  3. When your instructor has reviewed and signed off on this project, post it in your online portfolio.

Due date: mmddyy

Information and programs provided by hcexres@prismnet.com.