Course Name

Document Design and Usability

Contact Hours: 24

Course Description

Learn how to successfully integrate text and graphics to effectively present complex technical information for delivery through conventional, paper-based documents as well as electronic media including web pages. Beginning with principles of good document design, this course covers situation and audience analysis, document planning, page layout, formatting, revising, and online authoring.

Outcome

The instructor will review all quizzes and documents and will provide feedback.

Assessment

The student will produce at least three documents, which will be reviewed by the instructor. There will also be online and textual reading, as well as weekly quizzes based on the text. The text used for this course is Writing Software Documentation by Thomas T. Barker. ISBN 0-205-19576-8. Price $49.95. Additional reading from Internet articles will also be included.

Outline

Week 1: Introduction, Language Usage and Getting Started This module provides an overview of the course, as well as tips for writing effective user documentation.  Week 2: Document Design and Layout This module provides details on effective and user-friendly document design, including the use of graphics and screen shots. From this module alone, you will learn the secret to writing a technical manual that can be easily used again and again. Week 3: Writing a Tutorial This module provides details on how to write a tutorial, the different types of tutorials, and how to produce one that fits your user's exact needs.