210E F18 Deveau

210E 

Syllabus

Genres of Technical Communication

(ENGL 210E)

General Information                       Course Instructor

Section Number: 001                       Dr. Danielle J. Deveau

Hours: T/Th 11:30am-12:50pm        Office: HH254

Location: HH139                               Email: d2deveau@uwaterloo.ca

Term: Fall 2018                                  Phone: 519 885 1211 ext. 32122

Office Hours: T/Th 1pm-2:30pm 

Teaching Assistant

Sally Bernadette Beresford Email: s3beresf@uwaterloo.ca Office Hours: By appointment

Course Description and Objectives

This course will introduce you to the principles and practices of technical communication. Through both individual and group work you will produce documents based on various genres that are common in technical communication, and you will become familiar with the typical writing processes and media that are used to produce technical documentation. In addition, you will learn to write prose that is clear, accurate, and correct.

Texts

Markel, Mike. Practical Strategies for Technical Communication. 2nd ed., Bedford/St. Martin’s, 2016.

Graded Assignments

Assignment

Due Date

Weighting

Individual

Job Application Materials (resume, letter of application)

Sept. 20

10%

Recommendation or Information Report

Nov. 1

20%

Final Portfolio (e-submission)

Dec. 10

10%

Reading Quizzes (Learn)

Completed by Oct. 5

15%

Professionalism

n/a

5%

 

Group

Draft Technical documents

Oct. 4

10%

Group Presentation

Nov. 13; Nov. 20; Nov. 27

10%

Group Final Report

Nov. 29

20%

 

TOTAL

100%

Details of the assignments will be distributed during the course.

Course Policies

Assignments and Class Procedures

Assignments are due in-class unless otherwise noted. Late assignments will be penalized 10%. Assignments more that 5 days late will not be accepted. Attendance is mandatory. Completion of informal activities in-class will be evaluated as part of your professionalism grade (5%).

Electronics

Please mute your phones and do not answer them in class. If you have a genuine emergency for which your phone is needed during a particular class, contact me beforehand. Laptops and tablets are allowed for class-related purposes only. Use of devices for non-class-related purposes (surfing, email, chatting) or in a manner that is distracting to other students will lead to my requesting that you not bring your device to class. At some points in the class I may ask the class to shut their laptops.

Academic Integrity

In order to maintain a culture of academic integrity, members of the University of

Waterloo community are expected to promote honesty, trust, fairness, respect and responsibility. See the UWaterloo Academic Integrity Webpage (https://uwaterloo.ca/academic-integrity/) and the Arts Academic Integrity Office Webpage (http://arts.uwaterloo.ca/current-undergraduates/academic-responsibility) for more information.

Discipline

A student is expected to know what constitutes academic integrity to avoid committing academic offenses and to

take responsibility for his/her actions. A student who is unsure whether an action constitutes an offense, or who

needs help in learning how to avoid offenses (e.g., plagiarism, cheating) or about “rules” for group

work/collaboration should seek guidance from the course professor, academic advisor, or the undergraduate

associate dean. For information on categories of offenses and types of penalties, students should refer to Policy 71,

Student Discipline (http://www.adm.uwaterloo.ca/infosec/Policies/policy71.htm). For typical penalties check

Guidelines for the Assessment of Penalties

(http://www.adm.uwaterloo.ca/infosec/guidelines/penaltyguidelines.htm).

Grievance

A student who believes that a decision affecting some aspect of his/her university life has been

unfair or unreasonable may have grounds for initiating a grievance. Read Policy 70, Student Petitions and Grievances, Section 4 (https://uwaterloo.ca/secretariat/policies-procedures-guidelines/policy-70). When in doubt please be certain to contact the department’s administrative assistant who will provide further assistance.

Appeals

A decision made or penalty imposed under Policy 70, Student Petitions and Grievances (other than a petition) or Policy 71, Student Discipline may be appealed if there is a ground. A student who believes he/she has a ground for an appeal should refer to Policy 72, Student Appeals (http://www.adm.uwaterloo.ca/infosec/Policies/policy72.htm).

Note for Students with Disabilities

The Office for Persons with Disabilities (OPD), located in Needles Hall, Room 1132, collaborates with all academic departments to arrange appropriate accommodations for students with disabilities without compromising the academic integrity of the curriculum. If you require academic accommodations to lessen the impact of your disability, please register with the OPD at the beginning of each academic term.

Tentative Schedule

Week

Dates

Topics

Activities

Readings

Due

1

Sept. 6

Course Overview and

Introduction

Twitter Introductions

Ch. 1; Ch. 9

Informal: Twitter

Bio

2

Sept. 11

Job Applications

Group Assignments/Roles

Ch. 10

 

Sept. 13

Collaboration and Ethics

Group Brainstorming Session

Ch. 3; Ch. 2

Informal: Field

Work Memo

3

Sept. 18

Understanding Audiences

Group Audience Profiles

Ch. 4; Ch. 5

 

Sept. 20

Writing Definitions,

Descriptions, and

Instructions

 

Ch. 14

Formal: Job

Application

4

Sept. 25

 

Group Work Period

 

Informal: Request

for Clarification

Sept. 27

Communicating

Effectively to your

Audience

 

Ch. 6

 

5

Oct.2

Research and

Documenting Sources

Citation Competition

Appendix A

 

Oct. 4

Writing to Inform

 

Ch. 12

Formal: Draft

Technical

Documents

6

Oct. 9

Fall Study Break 

Oct. 11

Independent Study

7

Oct. 16

Accessibility

Instruction Testing: “How do

I get to Tim Horton’s?”

Review Ontario

Accessibility Laws

(online)

 

Oct. 18

Writing to Convince

Accessibility

Recommendations

Ch. 11; Ch. 13

 

8

Oct. 23

Principles of Data

Visualization

 

Ch. 8

 

Oct. 25

Designing Graphics and

Documents

 

Ch. 7

 

9

Oct. 30

Oral Presentations

 

Ch. 15

 

Nov. 1

Group Work Period

Formal:

Information or

Recommendation

Report

10

Nov. 6

Editing and Proofreading

Peer Review Session

Appendix B

Informal: Draft

Portfolio

Documents

Nov. 8

 

Group Work Period

   

11

Nov. 13

 

Presentations

   

Nov. 15

Building a Brand

Social Media Branding

   

12

Nov. 20

 

Presentations

   

Nov. 22

Designing Online

Communication

Social Media Strategy

 

Informal: Present

social media plans

13

Nov. 27

 

Presentations

   

Nov. 29

Final Review and

Evaluation

   

Formal: Group

Final Report;

Informal:

Evaluations

Individual Final Portfolios due in Learn by Dec. 10 at 4pm.

Assignments – A walk through

The major project for this course will be to create an information handbook for incoming students in a faculty of your choice (from the student’s perspective).

It should be a comprehensive guide. Information categories can be of your choosing. You should carefully consider your audience and information hierarchies. You should consider what kind of detailed information a student new to campus might need, and how to communicate that information in a way that appeals to them. Your submission should demonstrate mastery of a range of technical communication genres including definitions, descriptions, instructions, and information visualization.

Your submission must also include a fun instruction section titled: “How do I get to Tim Horton’s from [location]?” This will be a detailed set of instructions that a student can take from a location (such as a building or a bus stop) to a Tim Horton’s on campus. You will be graded on the scope and clarity of your instructions, so make sure there is enough detail to be evaluated. Your instructions are due as part of your draft technical documents submission in Week 5, and will be tested in Week 7 by your peers.

You will have some class time to work on this project, but will also need to hold group meetings outside of the classroom. These should be scheduled with an agenda and a minute taker. Meeting minutes and agenda should be included in your draft and final group report submissions. Important email correspondence should also be included. You are expected to demonstrate mastery of technical communication in all aspects of your group project, from email correspondence and agenda setting, to document design and information clarity. Each group member should record his or her project time on a timesheet.

In your first meeting, you should assign project roles. You should also consider how meeting agenda will be set? Where will meetings be held (consider booking a group study room in the library). Who will be responsible for coordination? Who will be responsible for notetaking and document management?

Job Application due Sept. 20th.

This individual assignment will entail applying for a job as a technical writer to work with your group. If you have been assigned a specialized role (project manager, scheduler, graphics designer, etc.) you should apply for this more specific role. Your application should include a cover letter and a resume. A sample job ad will be distributed in class.

You will have class time to get started on your group project on Set. 11th, Sept. 13th, and Sept. 18 th. You should review the topics for these weeks prior to class so that you arrive ready to work with your group. On Sept. 25th you will have a formal, in-class work period. You should set an agenda for this class and bring a “Request for Clarification” for the instructor (this should be a formally written request submitted to the client with outstanding project questions that you need answered). As the client, your instructor will visit each group and answer questions. This is a great opportunity to get detailed help on your project.

Technical Document Drafts due Oct. 4th.

This submission should include copies of meeting agenda and minutes, as well as samples of email correspondence. It should also include a proposed outline for your student manual and a few sample sections. These sections should have written content and be clean, well-edited, and clear, but do not need to have final graphics/designs. For example, you could have an empty box where a picture will go. While this is a draft, it should still be free of grammatical errors and formatting idiosyncrasies. It must still look like a professional document.

You need to submit a copy of your “How do I get to Tim Horton’s from [location]?” instructions at this time as well.

These will be tested in-class on Oct. 16th.

Reading Quizzes completed by Oct. 5th.

In Learn you will find a series of quizzes related to textbook chapters. These are low-stakes, multiple-choice tests intended to reinforce reading comprehension. Quizzes should be completed shortly after reading the relevant textbook chapter, can only be completed once, cannot be paused, and must be completed within a constrained timeframe (between 30 minutes and one hour depending on the number of questions). All quizzes should be

completed by Dec. 3rd for points to be awarded.

Information or Recommendation Report due Nov. 1

In producing a student manual, you might find that there are certain aspects of student life that are particularly confusing, challenging, or restrictive. In this individual assignment, you will attempt to address one such issue. You will write either an information or a recommendation report to the appropriate University authority documenting a problem that you have perceived. For example, if food services do not meet student needs (dietary, location, timeliness), you could research who makes decisions about food offerings and submit a recommendation report on how to improve this service. The claims in your report should be supported by research.

On Nov. 1st you will have a group work period. You should set an agenda for this period prior to class.

On Nov. 6th you will have the opportunity to workshop some of your writing with your peers. You should bring any documents that you are planning to submit to your Final Portfolio (bio, job application, information or recommendation report, etc.) in a format that will allow your peers to easily review and provide feedback.

On Nov. 8th you will have another group work period. Set an agenda and come with any outstanding questions for the client.

Presentations: Nov. 13th , 20th , 27th.

Group presentations will be held in front of a review panel during the last 3 weeks of classes. Presentation timeslots will be randomly assigned. You only need to attend class on the day that your group is presenting. The review panel will consist of the course instructor, as well as one or two other instructors from the Department of English. Your group will be ‘pitching’ your student manual concept to the client. You will have 20 minutes to make the case that you have identified and met the needs of incoming students. You should report on research findings, audience analysis, as well as your final product (the report) and how it meets the student needs that you have identified. Your

final group report is not due until Nov. 29th, but you should have sample documents (or a sample manual if ready) to show the panel during your presentation.

Final Report due Nov. 29th.

This report should include the student manual that you have created, as well as supporting documents such as correspondence, agenda and minutes, timetables, etc. This is a “handover package” for the client, so should be well-organized (table of contents, section dividers, etc.) and submitted in a binder. It is your way of communicating what you have done to the client, so you may want to include research and audience profiles or other supporting materials if you have them.

Final Portfolio due Dec. 10th.

This individual assignment will be submitted to Learn (ePortfolio). It should be a demonstration of your individual abilities as a technical writer. Think of it as a portfolio for a future job application. You should include a range of sample documents. If including documents from your group project, your role in the document creation should be clearly explained.