Unit 1 DEFINING TECHNICAL WRITING
Chapter 1 An Introduction to Technical Writing
DISTINCTIONS
PURPOSES
IMPORTANCE
TEAMWORK
Business and Industry Expectations
Total Quality Management and Continuous Quality Improvement
Team Projects
Strategies for Successful Collaboration
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 2 Producing the Product
THE WRITING PROCESS: AN OVERVIEW
THE RATIONALE FOR PROCESS
Prewriting
Writing
Rewriting
THE PROCESS IN PRACTICE
Prewriting
Writing
Rewriting
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 3 Objectives in Technical Writing
CLARITY
Provide Specific Detail
Answer the Reporter's Questions
Use Easily Understandable Words
Use Verbs in the Active Voice versus the Passive Voice
CONCISENESS
Limit Paragraph Length
Limit Word and Sentence Length
ACCURACY
ORGANIZATION
Spatial
Chronological
Importance
Comparison/Contrast
Problem/Solution
ETHICS
Legalities
Practicalities
Ethicalities
Strategies for Making Ethical Decisions
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 4 Audience Recognition and Involvement
OBJECTIVES
AUDIENCE RECOGNITION
High-Tech Audience
Low-Tech Audience
Lay Audience
Multiple Audiences
DEFINING TERMS FOR DIFFERENT AUDIENCE LEVELS
MULTICULTURAL AUDIENCES
SEXIST LANGUAGE
Omission
Unequal Treatment
Stereotyping
Pronouns
Nouns
AUDIENCE INVOLVEMENT
Personalized Tone
Reader Benefit
AUDIENCE CHECKLIST
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Unit 2 CORRESPONDENCE
Chapter 5 Memos
OBJECTIVES
THE DIFFERENCES AMONG MEMOS, LETTERS, AND E-MAIL
CRITERIA FOR WRITING SUCCESSFUL MEMOS
Subject Line
Introduction
Discussion
Conclusion
Audience
Style
Grammar
PROCESS
Prewriting
Writing
Rewriting
EFFECTIVE MEMO CHECKLIST
PROCESS LOG
Prewriting
Writing
Rewriting
SAMPLE MEMOS
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 6 Letters
OBJECTIVES
LETTER COMPONENTS
Essential Components
Optional Letter Components
LETTER WIZARDS AND TEMPLATES
LETTER FORMATS
CRITERIA FOR DIFFERENT TYPES OF LETTERS
Letters of Inquiry
Cover Letters
Good-News Letters
Bad-News Letters
Complaint Letters
Adjustment Letters
Sales Letters
PROCESS
Prewriting
Writing
Rewriting
PROCESS LOG
Prewriting
Writing
Rewriting
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 7 The Job Search
OBJECTIVES
HOW TO FIND JOB OPENINGS
CRITERIA FOR EFFECTIVE RESUMES
Identification
Career Objectives
Employment
Education
Professional Skills
Military Experience
Professional Affiliations
Personal Data
References
Style
INTERNET RESUMES
ASCII Resumes
HTML Resumes
SAMPLE RESUMES
CRITERIA FOR EFFECTIVE LETTERS OF APPLICATION
Letter Essentials
Introduction
Discussion
Conclusion
Style
SAMPLE LETTERS OF APPLICATION
TECHNIQUES FOR INTERVIEWING EFFECTIVELY
CRITERIA FOR EFFECTIVE FOLLOW-UP CORRESPONDENCE
SAMPLE FOLLOW-UP LETTER
CHECKLISTS
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Unit 3 VISUAL APPEAL
Chapter 8 Document Design
OBJECTIVES
CHUNKING
ORDER
ACCESS
VARIETY
SUMMARY
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 9 Graphics
OBJECTIVES
Conciseness
Clarity
Cosmetic Appeal
COLOR
THREE-DIMENSIONAL GRAPHICS
CRITERIA FOR EFFECTIVE GRAPHICS
TYPES OF GRAPHICS
Tables
Figures
Internet Downloadable Graphics
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Unit 4 TECHNICAL APPLICATIONS
Chapter 10 Fliers, Brochures, and Newsletters
OBJECTIVES
WHY WRITE FLIERS?
CRITERIA FOR WRITING FLIERS
Process
WHY WRITE BROCHURES?
CRITERIA FOR WRITING BROCHURES
Title Page (Front Panel)
Back Panel
Body Panels (Fold-in and Inside)
Document Design
Audience Recognition and Involvement
Accuracy
PROCESS
Prewriting
Writing
Rewriting
EFFECTIVE BROCHURE USABILITY CHECKLIST
WHY WRITE NEWSLETTERS?
CRITERIA FOR WRITING NEWSLETTERS
The Flag
Columns
Headlines and Subheadings
Pop-up Quotes
Sidebars
Table of Contents
Initial Caps
Newsletter Style
Highlighting
PROCESS
Prewriting
Writing
Rewriting
EFFECTIVE NEWSLETTER USABILITY CHECKLIST
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 11 Technical Descriptions
OBJECTIVES
Operations Manuals
Product Demand Specifications
Study Reports Provided by Consulting Firms
Sales Literature
CRITERIA FOR WRITING TECHNICAL DESCRIPTIONS
Title
Overall Organization
Internal Organization
Development
Word Usage
PROCESS
Prewriting
Writing
Rewriting
TECHNICAL DESCRIPTION CHECKLIST
PROCESS LOG
Prewriting
Writing
Rewriting
SAMPLE TECHNICAL DESCRIPTION
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 12 Instructions and User's Manuals
OBJECTIVES
CRITERIA FOR WRITING SHORT INSTRUCTIONS
Title
Organization
Audience Recognition
Graphics
Style
PROCESS
Prewriting
Writing
Rewriting
EFFECTIVE INSTRUCTION CHECKLIST
PROCESS LOG
Prewriting
Writing
Rewriting
SAMPLE INSTRUCTION
CRITERIA FOR WRITING A USER'S MANUAL
USABILITY EVALUATION CHECKLIST
SAMPLE USER'S MANUAL WITH SCREEN CAPTURES
SAMPLE USER'S MANUAL
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Unit 5 ELECTRONIC COMMUNICATION
Chapter 13 E-mail, On-line Help, and Web Sites
THE INTERNET—THE "INFORMATION SUPERHIGHWAY"
THE INTRANET—A COMPANY'S INTERNAL WEB
THE EXTRANET—A WEB WITHIN A WEB
ON-LINE TECHNICAL WRITING APPLICATIONS: E-MAIL, ON-LINE HELP, AND WEB SITES
E-Mail
E-Mail Problems
Techniques for Writing Effective E-Mail
On-line Help
Techniques for Writing Effective On-line Help
Web Sites
Web Sites versus Paper Text
Criteria for a Successful Web Site
Process
WEB SITE USABILITY CHECKLIST
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Unit 6 REPORT STRATEGIES
Chapter 14 Research
OBJECTIVES
CRITERIAL FOR WRITING RESEARCH REPORTS
Audience
Effective Style
Formatting
PROCESS
Prewriting Research Techniques
Writing
Rewriting
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 15 The Summary
OBJECTIVES
CRITERIA FOR WRITING SUMMARIES
Overall Organization
Internal Organization
Development
Style
Length
Audience Recognition
Grammar and Mechanics
PROCESS
Prewriting
Writing
Rewriting
SUMMARY CHECKLIST
PROCESS LOG
Prewriting
Writing
Rewriting
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 16 Reports
OBJECTIVES
CRITERIA FOR WRITING REPORTS
Organization
Development
Style
TYPES OF REPORTS
Trip Reports
Progress Reports
Lab Reports
Feasibility Reports (Recommendation Reports)
Incident Reports
PROCESS
Prewriting
Writing
Rewriting
REPORT CHECKLIST
PROCESS LOG
Prewriting
Writing
Rewriting
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 17 Proposals
OBJECTIVES
CRITERIA FOR PROPOSALS
Title Page
Cover Letter
Table of Contents
List of Illustrations
Abstract (or Summary)
Introduction
Discussion
Conclusion/Recommendation
Glossary
Works Cited (or References)
Appendix
PROCESS
Prewriting
Writing
Rewriting
PROPOSAL CHECKLIST
SAMPLE PROPOSAL
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Chapter 18 Oral Presentations
OBJECTIVES
TYPES OF ORAL PRESENTATIONS
The Impromptu Speech
The Memorized Speech
The Manuscript Speech
The Extemporaneous Speech
CRITERIA FOR EFFECTIVE ORAL PRESENTATIONS
Overall Organization
Development
Style
Delivery
Appearance
Body Language and Gestures
Visual Aids
PROCESS
Prewriting
Writing
Presentation
SPEAKER'S CHECKLIST
POST SPEECH ACTIVITIES
CHAPTER HIGHLIGHTS
ACTIVITIES
QUIZ QUESTIONS
Unit 7 HANDBOOK
Chapter 19 Grammar, Punctuation, Mechanics, and Spelling
GRAMMER RULES
Agreement between Pronoun and Antecedent (Referent)
Agreement between Subject and Verb
Comma Splice
Faulty or Vague Pronoun Reference
Fragment
Fused Sentence
Modification
Parallelism
PUNCTUATION
Apostrophe
Colon
Comma
Dash
Ellipses
Exclamation Point
Hyphen
Parentheses
Period
Question Mark
Quotation Marks
Semicolon
MECHANICS
Abbreviations
Capital Letters
Numbers
SPELLING
PROOFREADER'S MARKS
ACTIVITIES
GRAMMER QUIZ
References
Index