
![]()
Syllabus
MS Word: A Writer's Perspective. Ron Mashburn's help for using Microsoft Word.
Day 1:
- What is technical writing?
The authority for technical writing standards & advice. Faults of science & engineering writing. Fundamental concerns of technical writing. Things to catch in revision.- Technical writing basics:
- Audience analysis
- Document design by explicit organization
- Graphics
- Technical writing goals:
Clarity, honesty, accuracy, comprehensiveness, conciseness, appearance, & grammar. Revising for visual organization & audience analysis.- Writing a technical document.
Understanding the problem; methods for audience analysis, table of contents, first draft, & revision.- Revising for grammar.
Passive voice, point of view, diction level, technical terms, pompous terms, frequently misused terms.- Organization & Revision.
A Near-miss Accident Report.- Case #1: Anti-smoking at Anders High School.
Controlled data for a case study.
Day 2:
- Case#1: solutions.
How the case data might be organized & presented.- Techno-babble & Grammar.
Causes, Jargon, Grammar, the Federal mandate for plain language documents.- Memo revision.
A revised memo.- Pantex Radiation Protection Program Assessment.
A revised Pantex report.- Collaborative Writing.
Advantages & disadvantages, meetings, conducting meetings, critiquing drafts, reviews (peer, factual, editorial, management, security).- Case #2: data.
Controlled data for a case study.- Case #2: assignments.
- Case #2: phone log solution.
Notes for a phone call to solve some of the case problems.
Day 3:
- Case #2: letter solution.
A formal letter that may solve the problems.- Case #2: evaluation criteria.
Points to consider in evaluating student solutions.- Case #2: audience analysis.
Explanations of choices used to write the letter (#15).- Technical writing logic & the Internet. Unintended humor, e-mail, & producing online documents.
- Grammar & the Chicago Manual of Style. Grammar & usage questions answered by the editors of the most influential style guide.
- Editing again.
Copy marking symbols, steps in document production, types of editing & their concerns.- Interviews.
Preparing for an interview, conducting the interview, managing the interview; confidentiality, observation.
References & Acknowledgments.
MS Word: A Writer's Perspective.
John Rothfork, West Texas A&M University.