Technical Communication

Curriculum guideline

Effective Date:
Course
Discontinued
No
Course code
CMNS 3500
Descriptive
Technical Communication
Department
Communications
Faculty
Language, Literature & Performing Arts
Credits
3.00
Start date
End term
Not Specified
PLAR
No
Semester length
15 weeks
Max class size
30
Course designation
None
Industry designation
None
Contact hours

Lecture 2 hours/week

Lab 2 hours/week

 

Method(s) of instruction
Lecture
Lab
Learning activities

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 communication project during the course. Students will be required to work collaboratively on selected assignments.

Course description
This course develops an understanding of how technical communication projects (such as software manuals and policy and procedures manuals) are planned, written, and produced for online, print, and video delivery. Beginning with an analysis of objectives and audience, students will prepare a number of effective and professionally produced technical communication projects using industry-standard software programs. The focus of the course is on content development with an opportunity to produce a project for industry clients. Students will also be introduced to key trends and issues (ethical, cultural, technological, and economic) for technical communicators.
Course content

1. Technical Skills for Professional Communicators

Students will

  • become familiar with the technical skills required by technical communicators
  • assess their own current skill levels
  • become familiar with the various software programs used by technical communicators
  • understand the strengths and weaknesses of those programs
  • develop their current skill levels through a series of structured lab exercises

2. Managing Technical Communication Projects

Students will

  • understand the basic elements of project management (quality, scope, cost, and schedule) for technical communication projects
  • estimate and monitor the time required to prepare a project
  • prepare a detailed schedule of activities to produce the project
  • become familiar with the options available for distribution and production
  • produce a group project (for example, a small instructional manual) using MS Word skills

3.  Genre Analysis of Technical Manuals

Students will

  • understand the purpose of a technical manual and the differences between user, reference, and training manuals
  • become familiar with the types of technical materials produced by technical communicators in the local marketplace
  • become familiar with the companies employing technical communicators, the types of product and services they provide, and the types of manual they produce
  • analyze the range of materials required to support a product, such as a software program or video
  • 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
  • be introduced to the different types and uses of online documentation (information that is meant to be read from the computer screen) 

4. Developing Content for a Technical Communication Project

Students will

  • understand the role of the technical communicator in the product development lifecycle
  • interview a subject-matter expert to obtain the information necessary to prepare technical documentation
  • prepare and evaluate a project plan, including an outline and a schedule
  • examine the means of ensuring the technical accuracy of projects, including review and approval cycles
  • examine the need for testing and the relationship with product testing
  • write and evaluate a technical communication project based on the prepared plan (including a table of contents, index, front matter, and sample chapters)
  • become familiar with the mode of discourse typically employed in technical communication projects (that is, writing to do)
  • evaluate the different means of communicating technical information (for example, 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 communication projects
  • understand the role of editing in the preparation of technical communication projects

5. Basic Production of a Technical Communication Project

Students will use Microsoft Word and Adobe Acrobat to

  • format revisable and reliable copy
  • structure documents into sections with dynamic headers and footers
  • create and use templates and styles for consistency
  • test and debug the project
Learning outcomes

Students who successfully complete this course will

  1. gain an overview of the technical skills required by professional communicators
  2. learn the methodology for planning technical communication projects
  3. understand and know when and how to use appropriate writing and formatting conventions
  4. learn how to use industry-standard software to produce a project such as a manual
  5. understand the writer’s role in the team approach to technical communication projects
  6. be familiar with key trends and issues in the field of technical communication
  7. create and revise generative AI prompts for relevant and applicable content
Means of assessment

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.

Instructors may use a student's record of attendance and/or level of active participation in the course as part of the student's graded performance. Where this occurs, expectations and grade calculations regarding class attendance and participation will be clearly defined in the Instructor Course Outline.

Assessment will be based on course objectives and will be carried out in accordance with the ÌÇÐÄvlog´«Ã½Evaluation Policy. An evaluation schedule is presented at the beginning of the course. This is a graded course.

Example evaluation schedule:

Short assignments (4 to 6) 65%
Technical communication project 30%
Attendance/professionalism/participation  5%
Total 100%
Textbook materials

A list of required textbooks and materials is provided for students at the beginning of the semester. Example texts include:

  • coursepack of required readings 
Prerequisites

Acceptance into the Post-Degree Diploma in Professional Communication

OR

A minimum of 45 credit hours including a university-transfer course in English, Communications, or Creative Writing with a grade of B or higher

OR

Permission of the Professional Communication Program Coordinator

Corequisites

None

Which prerequisite

None