This course will use a combination of teaching methods, including lecture, demonstration, group discussion, analysis of samples, and in-class and home exercises and projects. The emphasis will be on learning by analysis reinforced with hands-on practice wherever possible. Students will be required to prepare, write, and produce all, or portions of, a technical manual during the course. Students may be required to work collaboratively on selected assignments.
- 1. Introduction to Writing Technical Manuals
Successful students will:- become familiar with the various types of technical materials produced by technical writers in the local marketplace
- become familiar with the various companies employing technical writers, the types of products and services they provide, and the types of manuals they produce
- understand the differences between user, reference, and training manuals
- Planning and Organizing Manuals
Successful students will:- understand the purpose of a technical manual
- analyze the range of manuals required to support a product, such as a software program
- conduct user and task analyses, defining objectives and identifying and understanding readers’ information needs
- identify the different ways of organizing technical manuals and the specific uses and applications of each method
- Technical Writing Process
Successful students will:- understand the role of the technical writer in the product development lifecycle
- interview a subject-matter expert to obtain the information necessary to prepare a technical documentation
- prepare and evaluate a manual plan, including an outline and a schedule
- examine the means of ensuring the technical accuracy of manuals, including review and approval cycles
- examine the need for manual testing and the relationship with product testing
- write and evaluate a manual based on the prepared manual plan (including a table of contents, index, front matter, and three or more sample chapters)
- Manual Writing Style
Successful students will:- become familiar with the mode of discourse typically employed in technical manuals (i.e., writing to do)
- evaluate the different means of communicating technical information (e.g., flow charts, decisions, trees, illustrations) and understand the uses and applications of each
- examine the characteristics of conversational writing and practise writing technical materials in a conversational style
- understand the uses of examples in technical manuals
- understand the role of editing in the preparation of technical manuals
- Writing On-line Documentation
Successful students will:- be introduced to the different types and uses of on-line documentation (information that is meant to be read from the computer screen), such as help screens and hypertext systems
- Project Management
Successful students will:- understand the elements of project management (quality, scope, cost, and schedule)
- estimate the time required to prepare a defined manual
- prepare a detailed schedule of activities to produce a technical manual
- understand the options for manual production
- Basic Manual Production
Successful students will use Microsoft Word to:- format revisable and reliable copy
- structure documents into sections with dynamic headers and footers
- create and use templates and styles for consistency in a series of manuals
- Introduction to FrameMaker
- Successful students will use Adobe FrameMaker to:
- apply styles, create tables, insert graphics, and use variables
- add navigation elements, including a table of contents, chapter and page numbering, and cross-references
- create a FrameMaker “book” file and prepare a complete manual for publication
Students will learn the methodology for preparing technical manuals. They will understand, and know when and how to use, the special writing and formatting conventions of technical manuals. They will learn to use Microsoft Word and Adobe FrameMaker to produce revisable technical manuals.
Students are expected to be self-motivated and to demonstrate professionalism, which includes active participation, good attendance, punctuality, effective collaboration, ability to meet deadlines, presentation skills, and accurate self-evaluation.
Evaluation will be based on this general format:
| Short assignments (4 to 6) | 30% |
| Interview (e.g., with subject-matter expert and product manager) | 10% |
| Documentation plan | 20% |
| Manual project | 30% |
| Professionalism (as defined) | 10% |
| 100% |
Texts may include:
- Microsoft Manual of Style for Technical Publications. 2nd ed. Microsoft Press, 1998
- Writing Technical Manuals [coursepack, including articles from the Society for Technical Communication’s Journal and Intercom magazines]
Software may include:
- Microsoft Word
- Adobe FrameMaker
- Adobe Acrobat
Acceptance into program or permission of the coordinator