TECW 1107: Designing and Writing Manuals
Department
Technical & Creative Writing
School
Continuing Studies
Description
Review the document development process for producing effective manuals and training guides. Topics include information design techniques, improving usability of manuals via reader analysis and peer review, and considerations for internationalizing documents.
Course Learning Outcomes
Upon successful completion of this course, students will be able to:
- Students will learn standards for effective manual production and design. By examining industry standards and case studies, students will be able to prepare a personal manual style guide for their industry/area of interest. Students will also review the protocols and procedures for developing manuals in a team environment.
Prior Learning Assessment & Recognition (PLAR)
None
Hours
Lecture, Online, Seminar, Tutorial: 6.5
Total Hours: 6.5
Grading System
Satisfactory/Unsatisfactory
Evaluation Plan
Type
|
Percentage
|
Assessment activity
|
Assignments
|
|
Students must submit an assignment within two weeks of the session end date. Assignments are designed to build a professional portfolio.
|
Course topics
- The manual writing process
- Standards and styles for manuals
- Determining project scope and key content
- Working with subject matter experts (SME)
- Research and development
- Draft manual product10n tips
- Incorporating changes and redrafting
- Audience analysis and user-testing techniques
- Lessons learned
Notes:
- Course contents and descriptions, offerings and schedules are subject to change without notice.
- Students are required to follow all College policies including ones that govern their educational experience at VCC. Policies are available on the VCC website at:
https://www.vcc.ca/about/governance--policies/policies/.
- To find out if there are existing transfer agreements for this course, visit the BC Transfer Guide at https://www.bctransferguide.ca.