LCC3401: Technical Communication Practices

advertisement

Instructor

Contact

Details

Course

Description

Learning

Outcomes

Required

LCC3401: Technical Communication Practices

Fall 2008

Danielle Lawson

Office:

Skiles 309

Telephone:

404-894-1021 (shared office phone, please try email first)

Office hours: E-mail: dlawson@lcc.gatech.edu TR 10:45m – 1pm; W 11am-1pm. Other times by appointment.

Whether you realize it or not, you are surrounded by technical communication everyday. Each time you read the directions on a microwave dinner, skim an article in Science News , or look at your car’s service manual, you are using technical communication documents. Even this syllabus is a type of technical communication!

Many people think technical communication is limited to printed material. Yet there are many different types of technical communication including: posters, web pages, training videos and even podcasts.

In short, technical communication is a multi-faceted form of communication designed to meet various goals, such as:

 providing information;

 defining and describing products, materials and processes;

 helping people use products and complete tasks;

 ensuring safety; and

 facilitating a range of tasks.

LCC3401 builds on the skills developed in 1101-02 using the ‘WOVEN’ approach (written, oral, visual, electronic & non-verbal). Through the duration of this course students will work on:

 analysing communication situations and audiences in corporate and other professional settings;

 collecting and analysing the information required by those situations and the audiences;

 using principles of document design to create and present clear, readable content for specific situations and audiences;

 addressing the ethical and legal concerns posed in creating and disseminating technical documents;

 employing graphics to achieve maximum clarity in oral and written presentations;

 presenting clear and focused oral presentations of technical material;

Burnett, Technical Communication , 6 th

ed. (available at Engineer’s Bookstore

Lawson

Texts

TechComm Spring 2008

Additional materials available in library reserve or posted to T-square. Check the course schedule for information.

General Course Information

Make-up

Work

Student

Athletes

Late Work &

Extensions

Teamwork &

Collaboration

Policy

Due to the nature of discussion/workshop based classes make up work is rarely possible. If you miss class due to an excused absence, you can turn in any homework due within 24 hours. Should you miss in-class activities you will need to consult with the rest of your team regarding what was missed.

No class absences will be excused for athletic activities unless official notification is received from the registrar.

As a general rule, extensions are only granted under extenuating circumstances

(sudden hospitalisation, death in the family, etc...). Extensions will not be granted for any of the following reasons (or reasons similar to these):

 previously planned travel/vacations;

 previously planned dental work/doctor appointments;

 a project due or test on the same day in another class;

 computer malfunction (keep a backup copy of EVERYTHING);

 hair/tanning appointments (yes...I have had this excuse come up);

 or anything that is known about in advance or avoidable.

If you experience extenuating circumstances, the following procedures must be followed to be considered for an extension.

Consideration on the due date or up to 48 hours after

Email me with the reason (documented proof will be required – go see the student counsellors at the medical center), your proposed timeline for completion (not more than 7 days in length) and the assignment in full draft form. If you do not have a full draft or nearly complete draft by the due date, I will not grant an extension. In this class there is no excuse for not having a nearly complete draft at least two days before the due date.

Consideration 1 week -48 hours prior to the due date

Email me with the reason (documented proof is still required), your proposed timeline for completion (limited to 1 week past the due date) and all of the work you have on the assignment. By this point you should have at least a full outline, significant notes, or a partial draft. If you do not have at least this level of work completed, an extension will not be granted. Essentially, you must submit evidence to show that you have done significant preparatory work toward completing the assignment.

Teamwork is an integral part of the business world. As a result, students are expected to have (or develop) effective skills for working in teams. In this course students will be placed in teams of 4-6 students to work on in-class activities, provide peer review on individual assignments and to complete two

2

Lawson TechComm Spring 2008

Students with

Disabilities

Academic

Misconduct multi-faceted collaborative projects.

Students are expected to manage their groups effectively, including dealing with any ‘social-loafing’. Although students should, in the first instance, try to resolve any problems as a team, I am happy to mediate should the need arise.

If a team member misses too many classes and/or team meetings, or misses more than two team deadlines without a reason acceptable to the team, they may be ‘fired’ from their project team. Anyone who is fired from their team will be required to complete the final project on their own and will lose 30 points from their project grade for failing to be a responsible, reliable or effective team member.

‘Students with disabilities’ includes any person who has a documented physical or mental impairment that substantially limits one or more major life activities, has a record of such impairment, or is regarded as having such an impairment.

“Teaching at Georgia Tech: A Handbook for Faculty,

Instructors and Teaching Assistants”, 2007, p. 39

I am happy to work with students who have disabilities and feel they may need special accommodation regarding some class activities or assessments. That said, it is the student’s responsibility to contact the ADAPTS office regarding their disability. The ADAPTS office will then issue official documentation to your professors/instructors. This must be done early in the semester. Please do not wait until the first assignment is due to request accommodation.

Academic misconduct is a serious issue and one that could have a considerably negative impact on your university career, and in some cases your life after university. The ‘Student Conduct Code of the Rules and Regulations’

(Georgia Institute of Technology General Catalogue, Section XIX) states,

“Academic misconduct is an act that does or could improperly distort student grades or other academic records.” Academic dishonesty includes (but is not limited to):

 possessing, using or exchanging improperly acquired written or verbal information in the preparation of any essay, laboratory report, examination, or other assignment included in an academic course (e.g. using electronic devices to cheat on exams);

 substitution for, or unauthorized collaboration with a student in the fulfilment of academic requirements (e.g. paying someone to write/prepare an assignment or take an exam in your place);

 submission of material that is wholly or substantially identical to works created or published by another person or persons, without appropriate authorship citations (plagiarism);

 submission of work that has previously been submitted by anyone

(including the student) for any other academic grade;

 alteration or insertion of any academic grade or rating so as to obtain an unearned academic credit;

3

Lawson

Plagiarism

Technology

Etiquette

Respect and

Classroom

Expectations

TechComm Spring 2008

 deliberate falsification of a written or verbal statement of ‘fact’ to a member of the faculty so as to obtain unearned academic credit;

 forgery, alteration or misuse of an Institute document relating to the academic status of a student.

Students who engage in academic dishonesty will likely receive a zero on the assignment in question, and may fail the whole course. All instances of academic dishonesty will be reported to the Dean of Students.

The textual component of all assignments should be uploaded to turnitin.com on the day the assignment is due. The unit password and course number will be announced in week 2. Please note that turnitin.com only accepts text – no graphics. I suggest that students just cut and paste the text across into turnitin.com.

I take plagiarism very seriously in this course. Any information over 6 words in length that is taken verbatim from any source must be appropriately referenced in an acceptable professional style. Instances of significant plagiarism must be reported to the Dean of Students. Minor or potentially accidental instances of plagiarism (e.g. 1-2 sentences in different places) or pseudo-plagiarism (e.g. a direct quote that is improperly cited in the text, without quotation marks or page numbers) will result in the lowering of your assignment grade 10% per instance.

New media technologies have had a significant impact on every aspect of our lives. However, not all uses are constructive. In this course, use of any technology that distracts other students (or me) during class meetings is discouraged. This includes (but is not limited to) answering cell phones, engaging in text messaging, using computers for non-class related pursuits during class meetings, etc....

Outlined below is what I expect from students in my classes, followed by a list of what students can expect from me in return.

I expect students to:

 be on time for all class meetings*;

 turn cell phones off or to silent mode;

 refrain from using computers, cell phones or other electronic devices during class unless engaging in class activities;

 do all class reading before class so that they are prepared to participate;

 approach the class with an open mind;

 respect the ideas of others (even if they don’t agree);

 participate fully in all class discussions and activities;

 take full responsibility for their academic life;

 turn in all assignments on time; and

 work effectively in their project teams.

*If you are going to consistently be late due to travel time from a previous class, please bring your schedule to me by the end of week 2 to make arrangements.

4

Lawson TechComm Spring 2008

Students can expect me to:

 treat all students with respect;

 actively encourage everyone to participate;

 listen to their ideas with an open mind;

 have 4 hours of office consultation per week;

 arrange special consultation times if needed (email me to make an appointment);

 answer all emails within 24 hours (M-F); and

 endeavour to return all assignments in a timely manner.

Assignments & Exams

Full details and instructions for the following assignments are available on the T-square site for this unit, in the ‘Resources’ section. Please read the documents there before the start of week 2.

Date

08/26

Individual Assignments

Diagnostic in-class writing assignment (at start and end of semester – graded based upon overall improvement)

Mini Assignments (x4 - various due dates)

10/02 Technical Definitions

Weighting (60%)

5%

10%

10%

15% 10/23 TechComm History Project & Presentation

(individual component)

11/01 Community Service Analytical Report & Proposal

(individual component)

TBA Final Exam

Date Group Project Assignment(s)

10%

10%

Weighting (40%)

10/02 Instructions & Procedures

10/23 TechComm History Project & Presentation

10%

5%

11/01 Community Service Analytical Report & Proposal 10%

12/02 Community Service Documents & Presentation 15%

Other Notes on Assignments

Assignments are graded out of 100 points. The final totals will be converted to grades out of 100:

100-90 = A; 89-80 = B; 79-70 = C; 69-60 = D, 59 or less = F.

Grades will not be curved. Extra credit will be offered periodically at the start of class. If you are not there, you will not be eligible to submit that particular extra credit assignment. This is an added incentive to arrive on time for class.

Unless otherwise noted, all assignments are due in print , at the start of class. Any assignment not turned in by the time roll is taken will earn a 5% penalty, deducted from the grade earned. If the assignment is not passed in by the end of the class period, it will be counted as 1 day late and incur the standard 10% deduction. Assignments will not be accepted more than five days late and will receive an automatic zero grade.

5

Lawson TechComm Spring 2008

All text based assignments must be securely stapled where doing so will not mar the presentation of the document. If stapling is not possible, the assignment must be submitted in a presentation folder or some suitable container. Any multimedia components (CDs, DVDs, etc...) must be submitted in a secure document wallet with all other print materials required. I will not accept responsibility for CDs/DVDs that are lost due to being submitted without an appropriate secure binding.

Deductions for lack of attention to detail

A 5% penalty will be deducted from the grade earned on an assignment for:

 failing to staple an assignment or submit it in a proper document/presentation folder/wallet.

 forgetting to clearly put your name on an assignment.

 failing to number all pages of a document (if appropriate).

 using anything less than 12 point font in standard documents (this does not apply to the final group project documents).

Attendance & Participation

Students are expected to behave in a professional manner while in this class, which includes attendance and participation. Participation is not the same as attending class. Attendance merely requires showing up, while participation requires that you be actively involved in the class discussion and activities. As such, I do not give a grade for attendance. Each student is allowed three unexcused absences , after which a point penalty will be applied to the final grade

(x/100%).

Late arrival for class is taken VERY seriously, as it is disruptive to have students wandering in once class has begun. Please note the following:

Three late arrivals will count as one unexcused absence (if you are late six times that counts as two unexcused absences).

Arriving more than 15 minutes after class has begun will count as an unexcused absence.

Perfect attendance (weeks 2-16)

1 unexcused absence

2 unexcused absences

3 unexcused absences

4 unexcused absences

5 unexcused absences

>6 unexcused absences

+3 points

+2 points

+1 point no bonus/no penalty

- 1 point

-2 points

-3 points each

For example, missing 7 days would result in a 9 point penalty. A final grade of 97% (A) would be reduced to 88% (B).

Students are expected to participate fully in all class sessions, this means they will be prepared with all necessary assignments, activities and will have read all assigned texts. As part of participating in the class, all students are expected to listen to the ideas of others and to treat their peers (and the instructor) with respect – this includes turning mobile phones off at the start of class and paying attention to class discussion and lectures (rather than playing on your laptop or

6

Lawson TechComm Spring 2008 mobile). Please note, in this class all students are to be treated with respect regardless of race, religion, sexuality, etc... Anyone who cannot do so is advised to drop this section and sign up for a different one. Students who fail to treat their peers or the instructor with respect will be asked to leave the class. Should their behaviour continue they will be referred to the Dean of Students.

Class Schedule

Week Date Topic

MODULE 1: FOUNDATIONS OF TECHNICAL COMMUNICATION

1 T 08/19 Syllabus Overview

R 08/21 Introduction to Technical Communication

2 T 08/26 Writing Diagnostic

R 08/28 Reading Technical Communication and Document Usability

Reading:

Burnett Textbook Ch. 3 “Reading Technical Information”

Book Reserve – Lannon Ch. 3 “Delivering Usable Information”

In-Class Activities:

Rubrics as Evaluation Tools

Hand out guidelines for Mini Assignment 1 – Emergency Notification

Messages

3

4

T 09/02

R 09/04

T 09/09

Pre-writing: Know Your Audience

Reading:

Burnett Textbook Ch. 4 “”Addressing Audiences”

Web: “How to Stop Writing Documentation and Start Working for Your

Users” (Karen A. Bergen, 2001) http://tc.eserver.org/19501.html

Being Persuasive & Preparing Correspondence

Reading:

Burnett Ch. 18 “Preparing Correspondence” pp. 645-656

Book reserve – Lannon Ch. 4 “Being Persuasive”

Due at start of class:

Mini Assignment 1 – Emergency Notification Messages

The Writing Process: Document Planning, Drafting & Revising

Reading:

Burnett Ch. 7 “Planning and Drafting”

Burnett Ch. 8 “Revising and Editing”

In Class Activity:

Small groups – persuasive memos

R 09/11 Technical Definitions

Reading:

Burnett Ch. 14 “Creating Technical Definitions”

In-Class Activity:

Exercise – Technical Definitions

5 T 09/16 Document Design & Visual Forms (Print)

Reading:

7

Lawson TechComm Spring 2008

6

R 09/18

T 09/23

R 09/25

Book reserve – Kimball & Hawkins “The Whole Document” pp. 71-113

Book reserve – Kimball & Hawkins “Pages” pp. 115-150

Due at start of class:

Mini Assignment 2: Correspondence

Document Design & Visual Forms (Online)

Reading:

Burnett Ch. 12 “Using Visual Forms”

Web: “Document Design: A Brief Primer” (Melanie Flanders) http://www.stc.org/confproceed/1997/PDFs/0114.PDF

Web: “Blurbs: How to Write Them for Webpages”

(http://jerz.setonhill.edu/writing/e-text/blurbs.htm)

Web: “Newbie Web Author Checklist” (http://jerz.setonhill.edu/writing/etext/checklist.htm)

Technical Communication Through Time

Reading:

Burnett Ch. 12 “Using Visual Forms”

Bring to Class AND upload your historical examples to T-square!

In-Class Activity:

Final Project Group Allocation TODAY! This includes time to work on the first group project ...don’t miss it!

Working in Teams (Guest Lecturer)

Reading:

Burnett Ch. 8 “Collaborating in the Workplace”

Web : Collaboration Sessions (http://tc.eserver.org/26122.html)

MODULE 2: TYPES OF TECHNICAL DOCUMENTS

7 T 09/30 Instructions and Procedures

Reading:

Burnett Ch. 21 “Preparing Instructions and Manuals”

Book reserve – Lannon Ch. 22 “Instructions and Procedures” pp. 512-517

In-Class Activity:

Work on Instructions/Procedures Group Assignment

Due at start of class:

Group Project: Group Guidelines Memo

R 10/2 Instructions and Procedures

In-Class Activity:

Usability Testing & Activity Debriefing

Due at start of class:

Individual Assignment: Technical Definitions

8 T 10/7

R 10/09

Workshop Day – Historical Project

Due at start of class:

Revised Instructions/Procedures & Memo report

Group Project Info Session: Analytical Reports

Reading:

Book reserve – Lannon Ch. 24 “Formal Analytical Reports”

Book reserve – Lannon Ch. 25 “Front Matter and End Matter in Long

Documents”

8

Lawson

9

10

11

12

T 10/14

R 10/16

T 10/21

R 10/23

T 10/28

R 10/30

T 11/04

R 11/06

TechComm Spring 2008

* I recommend that each person in the group evaluate at least 1 existing community service client document over the break and write a complete draft of their section of the evaluation during that time. Groups do not need to require this, but that means you will have to do everything after the break. Having the analysis done before returning will help you know what questions you need answered by the client.

** Please note that 10/10 is the last day to drop with a W.

FALL BREAK

Group Project Research:

Guest Speaker

* NOTE: Come prepared to ask questions regarding information you need to complete the group project. Due to the guest’s work schedule, any additional questions must go through Dr. Lawson and you may not get answers quickly.

Group Project(s) Work Day:

Survey creation and document analysis

Creating Process Explanations

Reading:

Burnett Ch. 16 “Creating Process Explanations”

Book reserve – Lannon Ch. 21 “Technical Descriptions and Specifications”

Due at start of class:

Group Project: TechComm History Assignment

Group Project: 10 responses per group (in Excel format – uploaded to Turnitin)

Group Project Work Day:

Analytical Report & Proposal

Oral Presentations & PowerPoint

Reading:

Web: “PowerPoint Makes You Dumb” (Olive Thompson, 2003) http://tc.eserver.org/20999.html

Web: “PowerPoint is Evil” (Edward Tufte, 2003) http://www.wired.com/wired/archive/11.09/ppt2.html

Web: “Record Better Narration” (Jeffery P. Fisher, 2003) http://www.allbusiness.com/services/business-services-advertising/4247358-

1.html

Web: “Web Delivery of PowerPoint Presentations” http://www.presentersuniversity.com/courses_tutorials_tutorials_web.php

Web: “Understanding PowerPoint: Web Deliverable #5” (Dan Brown, 2002) http://tc.eserver.org/23827.html

Don’t forget: Group Project Analytical Reports and Proposals are due between 1 and

4pm this Friday (11/01) to Dr. Lawson’s office!

Due at start of class:

Mini Assignment 3: Persuasive bio-fuels newspaper insert

History of Tech Comm Project Presentations

Due at start of class:

Group Project: Analytical Report

History of Tech Comm Project Presentations

9

Lawson TechComm Spring 2008

13 11/11 Writing Technical Descriptions and Specifications

Reading:

Book reserve – Lannon Ch. 21 “Technical Descriptions and Specifications”

14

R 11/13

T 11/18

Signs – Effective Text for Limited Spaces

Ethics and Technical Communication

Reading:

“Mythmaking in Annual Reports” (David, C. April 2001, Journal of Business and Technical Communication ”) – available via ProQuest

Web: “The Ethics of Information Architecture” (Peter Morville, 2000) http://argus-acia.com/strange_connections/strange008.html

15

16

R 11/20

T 11/25

R 11/27

T 12/02

R 12/04

Workshop Day – Community Service Documents

Due at start of class:

Mini Assignment 4: Technical Description/Specifications

Workshop Day – Bring complete drafts for all documents today!

THANKSGIVING BREAK

Final Presentations & Exam Review

Due at start of class:

Group Project: Final documents & PowerPoint ‘handout’ for final presentation

Final Presentations & Exam Review

NOTE : The schedule is subject to change. Students will be notified in advance of any changes to due dates and the reading schedule.

About the Instructor

Hi and welcome to Technical Communication! I’m really happy to be at Georgia Tech as a

Brittain Postdoctoral Fellow. I am new to Atlanta, having relocated here from Brisbane

(Australia) in August 2007. Prior to that I was a Postgraduate Teaching Fellow at Bond

University (Gold Coast, Australia), teaching a range of communication courses including: Public

Speaking, Writing for University, New Media Communication Technologies, Human

Communication, Mass Media and Society, Advertising Principles and Practices, and Internet

Advertising.

I am originally from the US and graduated from Western Carolina University in 1997 with a degree in Journalism (Political Science minor). I just finished a PhD at Queensland University of

Technology, where I studied group membership and rule negotiation in Internet chat groups

(specifically Internet Relay Chat). I have written articles on various Internet chat topics and a book chapter on Internet research ethics.

Outside of my research and teaching, I am an avid gamer who likes to spend time playing World of Warcraft, Sims2 and just about any other online games I can get my hands on. When I’m not writing or playing games, I like to participate in medieval re-enactment (Society for Creative

Anachronism). If you have an interest in any of those topics, or just want to have a chat, feel free

10

Lawson TechComm Spring 2008 to drop by my office. For those gamers in the class, if you want to know my character nicks and preferred realms, just ask (yes, I have more than one character).

11

Lawson TechComm Spring 2008

Please read this page CAREFULLY. Tick the appropriate boxes and sign. Submitting this form at the start of the class in Thursday of week will count as your attendance for that day. No form means you will be counted as absent.

I, ________________________________________ (print your name on the line) have carefully read and fully understand the information provided in this syllabus AND the assignment details provided on T-square. I now know when the various assignments are due and how they are to be submitted. Further, I understand what is expected of me in this class and what the class policies are.

_______________________________

(sign and date)

On occasion I may want to keep your assignments for use in other classes as sample papers or as examples of student work in my research. Indicate below whether you would allow me to use the work you submit in this class for future classes or research. Proper citations will be given for any work used in research.

I, ____________________________________________ (print your name on the line)

 am happy for my work to be used as sample papers in future classes, as long as my name is removed.

 am happy for my work to be used as sample papers in future classes providing my authorship is made clear (name intact).

 am happy for my work to be used in future research regarding student work in technical communication, as long as my name is removed.

 am happy for my work to be used in future research regarding student work in technical communication providing my authorship is made clear (name intact).

 do not want my work used for any other purpose.

_____________________________________________

(sign and date)

12

Download