Technical Report Writing Today

Cover
IFC
Title
Copyright
Brief Contents
Contents
Preface
Organization
Special Pedagogical Aids And High-Interest Features
New To This Edition
Some Other Topics Have Been Revised
Ancillaries
Acknowledgments
SECTION 1: Technical Communication Basics
1: Definition Of Technical Communication
Chapter 1 In A Nutshell
A General Definition Of Technical Communication
What Is Technical Communication?
What Counts As Technical Communication?
Who Creates Technical Communication?
How Important Is Technical Communication?
Major Traits Of Technical Communication
Technical Communication Is Audience Centered
Technical Communication Is Designed
Technical Communication Is Responsible
Technical Communication Is Global
Exercises
Web Exercise
Works Cited
2: Profiling Audiences
Chapter 2 In A Nutshell
An Example Of Technical Writing
Who Is The Audience?
What Are The Audience’s Demographic
Characteristics?
What Is The Audience’s Role?
How Does The Reader Feel About The Subject?
How Does The Reader Feel About The Sender?
What Form Does The Reader Expect?
What Is The Audience’s Task?
What Is The Audience’s Knowledge Level?
Adapting To Your Audience’s Knowledge Level
Finding Out What Your Audience Knows
What Factors Influence The Situation?
What Consequences Will Occur From This Idea?
What Is The History Of This Idea?
How Much Power Does The Reader Have?
How Formal Is The Situation?
Is There More Than One Audience?
Creating Audience Profiles
Questions For An Audience Profile
Information-Gathering Strategies
Exercises
Worksheet For Defining Your Audience
Writing Assignments
Web Exercise
Works Cited
3: The Technical Communication Process
Chapter 3 In A Nutshell
An Overview Of The Process
Planning Your Document
Situate Yourself
Create An Audience Profile
Create A Document Plan
Design Your Information
Design Your Template
Create A Production Schedule
Worksheet For Planning—Short Version
Worksheet For Planning—Long Version
Drafting And Revising Your Document
Research To Discover Information
Design Your Information To Help Your Reader
Use Context-Setting Introductions
Place Important Material At The Top
Use Preview Lists
Use Repetition And Sequencing
Use Coordinate Structure
Testing
Worksheet For Drafting
Editing Or Finishing
Producing The Document
Worksheet For Editing
Exercises
Writing Assignments
Web Exercise
Works Cited
4: Technical Communication Style
Chapter 4 In A Nutshell
Sentence Strategies
Write In The Active Voice
Use Parallelism
Use There Are Sparingly
Avoid Nominalizations
Put The Main Idea First
Write Sentences Of 12 To 25 Words
Use You Correctly
Avoid Sexist Language
Eliminate Common Clarity Errors
Exercises
Exercises
Write Clear Paragraphs For Your Reader
Put The Topic Sentence First
Arrange Sentences By Level
Repeat Terms In A New/Old Sequence
Use The Dominant Position
Maintain Class Or Membership Relationships
Provide Transitions
Choose A Tone For The Reader
Worksheet For Style
Exercises
Writing Assignments
Web Exercise
Works Cited
5: Researching
Chapter 5 In A Nutshell
The Purpose Of Research
Questioning—The Basic Skill Of Researching
How To Discover Questions
How To Formulate Questions
Collecting Information From People
Interviewing
Surveying
Observing And Testing
Collecting Published Information
Develop A Search Strategy
Search Helpful Sources
Record Your Findings
Worksheet For Research Planning
Exercises
Writing Assignments
Web Exercise
Works Cited
6: Designing Pages
Chapter 6 In A Nutshell
Using Visual Features To Reveal Content
White Space And Chunks
Report Bullets
Head Systems
Headers Or Footers, Pagination, And Rules
Using Text Features To Convey Meaning
Highlighters
Font, Font Size, Leading, Columns And Line Length,
And Justification
Combining Features To Orchestrate The
Text For Readers
Developing A Style Sheet And Template
Worksheet For A Style Sheet
Exercises
Writing Assignments
Web Exercises
Works Cited
7: Using Visual Aids
Chapter 7 In A Nutshell
Visual Thinking
The Uses Of Visual Aids
Creating And Discussing Visual Aids
How To Create Visual Aids
How To Discuss Visual Aids
How To Reference Visual Aids
Guidelines For Effective Visual Aids
Using Tables
When To Use A Table
Parts And Guidelines
Using Line Graphs
When To Use A Line Graph
Parts And Guidelines
Using Bar Graphs
Parts And Guidelines
When To Use A Bar Graph
Using Pie Charts
When To Use A Pie Chart
Parts And Guidelines
Using Charts
Troubleshooting Tables
Flow Charts
Gantt Charts
Layouts
Using Illustrations
Guidelines
Photographs
Drawings
Worksheet For Visual Aids
Exercises
Writing Assignments
Web Exercise
Works Cited
8: Describing
Chapter 8 In A Nutshell
Planning The Mechanism Description
Consider The Audience
Select An Organizational Principle
Choose Visual Aids
Follow The Usual Form For Descriptions
Writing The Mechanism Description
Introduction
Body: Description Of Mechanism
Other Patterns For Mechanism Descriptions
Planning The Process Description
Consider The Audience
Select An Organizational Principle
Choose Visual Aids
Follow The Usual Form For Writing Descriptions
Writing The Process Description
Introduction
Body: Description Of The Operation
Conclusion
Planning The Description Of A Human System
Writing The Description Of A Human System
Introduction
Body: Sequence Of A Person’s Activities
Conclusion (Optional)
Worksheet For Planning A Description
Worksheet For Planning A Description
Worksheet For Evaluating A Description
Worksheet For Evaluating A Description
Exercises
Writing Assignments
Web Exercises
Works Cited
SECTION 2: Technical Communication Applications
9: Sets Of Instructions
Chapter 9 In A Nutshell
Planning The Set Of Instructions
Determine Your Goal
Consider The Audience
Analyze The Sequence
Choose Visual Aids
Follow The Usual Form For Instructions
Writing The Set Of Instructions
Write An Effective Introduction
Write An Effective Body
Field-Testing Instructions
Worksheet For Preparing Instructions
Worksheet For Evaluating Instructions
Exercises
Writing Assignments
Web Exercises
Works Cited
10: Informal Reports And E-Mail
Chapter 10 In A Nutshell
Basic Strategies For Informal Reports
Introduction
Develop A Consistent Visual Presentation
Types Of Informal Reports
IMRD Reports
Brief Analytical Reports
Progress Reports
Summaries And Abstracts
Background Or Conceptual Reports
Outline Reports
E-Mail
Worksheet For Planning A Project
Worksheet For IMRD Reports
Worksheet For Informal Reports
Worksheet For Evaluating IMRDs
Exercises
Writing Assignments
Web Exercise
Works Cited
11: Developing Websites/Using Social Media
Chapter 11 In A Nutshell
Basic Web Concepts
Hierarchy
Web Structure
Reader Freedom
Guidelines For Working With Web Structure
Planning A Website Or Web Document
Decide Your Goal
Analyze Your Audience
Evaluate The Questions The Audience Will Ask
Determine Genre Guidelines
Evaluate And Select A Delivery Technology
Plan For Maintenance
Drafting For Screens
Online Reading Habits
Page Layout, High- And Low-Fidelity Wireframes,
And Mock-Ups
Organizational Schemes And Navigation
Navigation
Document Design Decisions
Testing
Audience Effectiveness
Consistency
Navigation
The Electronic Environment
Clarity
Worksheet For Planning A Website Or Document
Worksheet For Evaluating A Website
Exercises
Writing Assignment
Web Exercise
Social Media Exercises
Works Cited And Consulted
12: Formal Reports
Chapter 12 In A Nutshell
The Elements Of A Formal Report
Front Material
Transmittal Correspondence
Title Page
Table Of Contents
List Of Illustrations
Summary Or Abstract
Introduction
Conclusions And Recommendations/Rationale
The Body Of The Formal Report
Paginating
Indicating Chapter Divisions
End Material
Glossary And List Of Symbols
References
Appendix
Worksheet For Preparing A Formal Report
Exercises
Writing Assignments
Web Exercise
Works Cited
13: Recommendation And Feasibility Reports
Chapter 13 In A Nutshell
Planning The Recommendation Report
Consider The Audience
Choose Criteria
Use Visual Aids
Select A Format And An Organizational Principle
Drafting The Recommendation Report
Introduction
Conclusions
Recommendations/Rationale Section
Discussion Section
Planning The Feasibility Report
Consider The Audience
Determine The Criteria
Determine The Standards
Structure By Criteria
Writing The Feasibility Report
Choose A Format
Write The Introduction And Body
Worksheet For Preparing A Recommendation/Feasibility Report
Worksheet For Evaluating Your Report
Worksheet For Evaluating A Peer’s Report
Exercises
Writing Assignments
Web Exercises
Works Cited
14: Proposals
Chapter 14 In A Nutshell
Grant Proposals For Non-Profit Organizations
Background Of Non-Profits
How Foundations Announce That They
Support Non-Profits
Planning The Proposal
Read The Foundation’s Guidelines Carefully
Collect All The Relevant Data
Writing The Non-Profit Grant Proposal
The Internal Proposal
Writing The Internal Proposal
Use The Introduction To Orient The Reader
Use The Discussion To Convince Your Audience
Worksheet For Preparing A Proposal
Worksheet For Evaluating A Proposal
Exercises
Writing Assignments
Web Exercise
Works Cited
15: User Manuals
Chapter 15 In A Nutshell
Planning The Manual
Determine Your Purpose
Consider The Audience
Determine A Schedule
Discover Sequences
Analyze The Steps
Analyze The Parts
Select Visual Aids
Format The Pages
Writing The Manual
Introduction
Arrange The Sections
Test The Manual
Worksheet For Preparing A Manual
Exercises
Writing Assignments
Web Exercise
Works Cited
SECTION 3: Professional Communication
16: Presentations
Chapter 16 In A Nutshell
Planning The Presentation
Plan For Your Audience
Plan For The Situation
Plan Your Organizational Pattern
Plan Your Presentation
Making An Effective Presentation
Learn To “Dance” With Your Slides
Develop The Introduction
Navigate The Body
Develop A Conclusion
Rehearse Your Presentation
Deliver Your Presentation
Worksheet For Preparing An Oral Presentation
Worksheet For Evaluating An Oral Presentation
Exercises
Speaking Assignment
Writing Assignment
Web Exercises
Works Cited
17: Job Application Materials
Chapter 17 In A Nutshell
The Basic Format Of A Letter
Block Format And Modified Block Format
Elements Of A Letter
Internal Elements
Analyzing The Situation
Understand Your Goals
Understand Your Audience
Assess Your Field
Assess Your Strengths
Assess The Needs Of Employers
Planning The Résumé
Information To Include In A Résumé
Résumé Organization
Writing The Résumé
Planning A Letter Of Application
Analyze The Employer’s Needs
Match Your Capabilities To The Employer’s Needs
Writing A Letter Of Application
Apply In The Introduction
Convince In The Body
Request An Interview
Select A Format
Interviewing
Prepare Well
Use Social Tact
Perform Well
Ask Questions
Understand The Offer
Writing Follow-Up Letters
Worksheet For Preparing A Résumé
Worksheet For Writing A Letter Of Application
Worksheet For Evaluating A Letter Of Application
Exercises
Writing Assignments
Web Exercise
Works Cited
A: Brief Handbook For Technical Writers
Problems With Sentence Construction
Identify And Eliminate Comma Splices
Identify And Eliminate Run-On Sentences
Identify And Eliminate Sentence Fragments
Place Modifiers In The Correct Position
Use Words Ending In -Ing Properly
Make The Subject And Verb Agree
Use Pronouns Correctly
Problems With Number
Problems With Antecedents
Problems With This
Punctuation
Apostrophes
Brackets
Colons
Commas
Dashes
Parentheses
A Note On Parentheses, Dashes, And Commas
Ellipsis Points
Hyphens
Quotation Marks
Semicolons
Underlining (Italics)
Abbreviations, Capitalization, And Numbers
Abbreviations
Capitalization
Numbers
B: Documenting Sources
How In-Text Citation Works
Apa Method
Mla Method
The “Extension” Problem
The Apa Method
Apa Citations
Apa References
Article From An Online Periodical
The Mla Method
Mla Citations
Mla Works Cited List
Index
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
Y