Technical
Editing
The University of Tennessee, Knoxville
Fall 2008
|
Instructor: Dr. Russel Hirst Time: TR 11:10 a.m–12:25 p.m. Place: HSS 209 Phones: 974-6952 (o); 5401 (sec); 6926 (fax) Office hrs.: TTR 3:45–4:30 p.m., M 10:30–11:30 a.m. |
Course Description
Writing/editing for the world of work. Theory,
practice, and evaluation of technical editing skills, as well as orientation
to careers and professional concerns in technical communication. Though it focuses
on the skills necessary to intelligently edit the text of documents, this course embraces a larger range of editing considerations, such as organization, layout,
and visuals.
The term "technical" is very broad, embracing just about every species and medium of communication used in business, industry, and government. Documents staggering under the weight of abstruse mathematical, scientific, and engineering terms and visuals constitute just one variety of technical communication, and such documents are not our focus in this course.
Homework assignments and quizzes are frequent. Guest lecturers with specialties in various fields of technical communication may supplement my own lectures. The major assignment for the course is an extended editing project that you can later use as a portfolio piece.
Successfully editing technical material is a demanding task, requiring a comprehensive command of communication skills, exacting attention to detail, excellent interpersonal skills, and the discipline to get work done on schedule. Be prepared to work hard.
Required Text
Edmond Weiss, The Elements of International English Style (2005).
Oak
Ridge National Laboratory Document Preparation Guide
(ch. 6), Martin Marietta Energy Systems, Inc., 1989.
This text is available free as a pdf file (see link).
Recommended Texts
Harbrace College Handbook
(latest edition).
Webster's New International Dictionary of the English Language (latest edition) or The American Heritage Dictionary of the English Language (latest edition).
Note: Additional readings for the course may appear on the 460 schedule. I will announce any such readings and make clear your responsibility for them.
|
|
Absenteeism
A course like this functions most
effectively as a community of thinkers and communicators. When members are absent
too often, the entire community suffers. To encourage good attendance, I have
established the following rules:
1) Everyone starts out the semester with five "participation points"; that's like getting a free "A" on a five-point quiz. You keep these points if you never log an unexcused absence.
2) You lose two points for every unexcused absence. This extends past the five-point range if your absences warrant. I will excuse you if you are absent for reasons of illness, personal tragedy/emergency, important professional opportunity, or jury duty. Please do not ask to be excused for any other reason.
Homework & Quizzes
Homework is collaborative. I will assign homework teams. Each team will email me one MS Word or PDF file for the assignment.
Quizzes are announced. You may make them up only if you miss them for valid reasons (family emergency, medical problem, important career opportunity). Email me IN ADVANCE about these things if you possibly can.
Schedule for Technical Editing
Fall 2008
Schedule will adjust as semester unfolds. Stay alert.
August
21 Meet in HSS 209. Course objectives, structure, materials, and policies.
• Letter of Self Introduction (optional, non-graded assignment). Email to rkh@utk.edu.
• Assignment: Grammar & Mechanics quiz (diagnostic; not graded).
28 Class dismissed; Hirst out of town.
September
2 Grammar & mechanics. Finish discussion of Style Unit 1.
Collaborative exercise: passives.
Discuss "The Philosophy of Style" by Herbert Spencer. (Here is another [cleaner] format; same article).
Weiss, Chapter 1.
9 Discuss "Herbert Spencer's Philosophy of Style: Conserving Mental Energy" by Dr. Hirst.
This article appears in JTWC Vol. 34, No.4.
Quiz #1 (5 points).
11 Weiss, Chapter 2.
16 Discuss jargon article by Dr. Hirst, JTWC Vol. 33:3 (2003) pp. 201–229.
18 Bring a document you think you could use for your final editing project. More discussion of final editing project.
23 Virtures and Vices of Omission by Dr. Hirst.
25 Weiss, Chapter 3.
Discuss "Virtues and Vices of Omission."
30 Style Unit 7.
October
2 Quiz #2 (5 points).
9 Fall Break; class dismissed.
14 Style Unit 11.
Prep for mid-term exam.
16 Mid-term exam (15 points).
Bring the following items:
• Writing implement of your choice
• Dictionary
• Human brain (preferably your own)
Note: except for the dictionary, this is a closed book exam.
21 Guest presentation.
23 Weiss, Chapter 4.
Final projects.
28 Guest presentation (10 minutes).
30 In-class stylistic excercises.
Style sheets.
November
4 More on markup. Lear docs.
6 Weiss, Chapters 5 & 6.
Principles of document design: lecture.
Begin group document design exercise (in class).
11 Presentations by design groups.
13 Finish presentations by design groups. Counts as 5 points of homework.
18 More on document design.
For more instruction in document design: take English 466: Writing, Layout, and Production of Technical Documents (translation: using computers to design documents for the world of work). See my home page for link.
Style guides. ORNL Document Preparation Guide (chapter 6). Bring hard copy of ORNLDPG to class for ease of reference—but you don't have to make hard copy if you'd rather not spend the $$ to do so. If you wish to make hard copy of only the most-used pages, these are: 1-16, 24-32, 41-43, 54-60, 67-79. Familiarize yourself with organization and general content.
20 In-class collaborative quiz (4 points) based on ORNL Document Preparation Guide.
25 Discussion of in-class quiz. Discussion of final editing projects.
27 Thanksgiving Holiday.
December
2 Editing Project (35 points) due if you want written evaluation in addition to a number grade on your project. However, there is no grade penalty for turning in your project at beginning of the final exam.
Coaching for final exam; final discussion of final editing project.
9 Final exam (20 points): 10:15 a.m.–12:15 p.m. in HSS 209.
Final moment to turn in Editing Project.