Planning and Revision Checklist
How to Use Reporting Technical Information
Preface p. xvii
An Overview of Technical Writing p. 3
The Matter of Definition p. 4
Writing at Work versus Writing at School p. 4
Writing and Communicating at Work p. 8
The Foundations of Effective Technical Writing p. 10
The Qualities of Good Technical Writing p. 10
Exercises p. 11
Foundations p. 13
Composing p. 15
The Basic Parts of the Composing Process p. 16
Using the Composing Process in a Workplace Environment p. 25
Understanding the Composing Process: Why Bother? p. 26
Exercises p. 27
Writing for Your Readers p. 29
Goals of Communication p. 30
The Planning Process p. 30
Thinking about Your Readers: A Summary of Considerations p. 49
Exercises p. 51
Achieving a Readable Style p. 53
The Paragraph p. 54
Basic Principles of Effective Style p. 58
The Sentence p. 63
Exercises p. 77
Writing Ethically p. 85
Ethical Perspectives p. 86
Your Professional Obligations p. 86
Codes of Conduct p. 87
Recognizing Unethical Communication p. 90
Anticipating Consequences p. 95
Applying Principles p. 97
Handling Unethical Situations p. 97
Exercises p. 98
Writing for International Readers p. 103
Establishing a Perspective on International Communication p. 104
Understanding Readers from Various Cultures p. 105
Considering Culture in the Planning Process p. 113
Example International Documents p. 116
Writing Business Communications to Readers in Other Cultures p. 120
Culture and Graphics p. 124
Format Strategies in Other Cultures p. 126
A Final Word p. 128
Guides to Doing Business in Cultures around the World p. 128
Exercises p. 132
Techniques p. 135
Gathering, Evaluating, and Documenting Information p. 137
Asking Productive Questions p. 138
Looking for Answers p. 139
Evaluating Answers p. 148
Citing Sources p. 152
Exercises p. 153
Designing and Formatting Documents p. 155
Understanding the Basics of Document Design p. 156
Designing Effective Pages and Screens p. 165
Choosing Readable Type p. 171
Helping Readers Locate Information p. 179
Designing Web Sites p. 187
Testing Your Design p. 191
Exercises p. 196
Creating and Managing Text p. 203
Collecting and Grouping Information p. 204
Planning Content Development p. 205
Strategies for Developing Content p. 210
Organization and Content Development p. 218
Other Types of Development p. 223
Exercises p. 227
Developing the Main Elements of Reports p. 231
Prefatory Elements p. 232
Abstracts and Summaries p. 244
Discussion or Body of the Report p. 255
Online Reports p. 258
Exercises p. 265
Creating Tables and Figures p. 267
Choosing Illustrations p. 268
Creating Illustrations p. 278
Designing Illustrations Ethically p. 299
Exercises p. 308
Applications p. 313
Planning Correspondence and E-Mail p. 315
Determining Your Purpose p. 316
Analyzing the Audience p. 322
Composing Letters, Memos, and E-Mail p. 323
Finding the Appropriate Style p. 326
Special Considerations for E-Mail p. 330
Special Considerations for International Correspondence p. 332
Keeping Copies of Correspondence p. 335
Exercises p. 336
Creating Reports for Any Occasion p. 341
The Variable Nature of Reports p. 342
Liability and Report Writing p. 343
General Report Requirements p. 344
Determining Report Structure p. 350
Determining Internal Report Development p. 355
Importance of the Introduction and Summary p. 355
The Online Report p. 369
The Slide/Visual Presentation Report p. 371
Exercises p. 373
Developing Analytical Reports: Recommendation Reports and Feasibility Studies p. 375
Analytical Reports p. 377
Recommendation Reports p. 384
Feasibility Studies p. 387
Environmental Impact Statements p. 395
Exercises p. 397
Developing Empirical Research Reports p. 401
Major Sections of Empirical Research Reports p. 403
Other Examples for Analysis and Comparison p. 411
Exercises p. 425
Writing Proposals and Progress Reports p. 427
The Relationship between Proposals and Progress Reports p. 428
Proposals p. 429
Progress Reports p. 447
Physical Appearance of Proposals and Progress Reports p. 456
Style and Tone of Proposals and Progress Reports p. 456
Other Forms of Proposals and Progress Reports p. 459
Exercises p. 471
Formulating Instructions, Procedures, and Policies p. 475
Planning Instructions and Procedures p. 476
Structure and Organization p. 478
Theory Governing the Procedure or Instruction p. 480
Conditions under Which the Task Is to Be Performed p. 482
Steps in Performing the Task p. 485
Procedures p. 488
Policies p. 497
Exercises p. 501
Writing Collaboratively p. 503
Issues in Collaboration p. 504
Value of Collaboration p. 504
Techniques for Developing Collaborative Documents p. 505
Making Collaborative Projects Work p. 507
Collaborative Projects in Action p. 508
Exercises p. 509
Preparing Oral Reports: The Basics p. 511
Understanding the Speaking/Writing Relationship p. 512
Analyzing the Audience p. 513
Analyzing the Context p. 514
Determining the Goal of Your Presentation p. 515
Choosing and Shaping Content p. 516
Deciding How to Arrange and Organize the Content p. 516
Designing Each Segment: Guidelines p. 517
Choosing an Appropriate Speaking Style p. 519
Speaking to Multicultural Audiences p. 520
Using Techniques to Enhance Audience Comprehension p. 520
Planning Visuals to Enhance Your Purpose and Your Meaning p. 526
Designing and Presenting the Written Paper p. 528
Speaking Effectively: Practice, Practice, Practice p. 535
Exercises p. 538
Understanding the Strategies and Communications of the Job Search p. 541
Preparation p. 542
The Correspondence of the Job Search p. 548
Interviewing p. 563
Exercises p. 570
Handbook p. 573
Index p. 605
About the Authors p. 615
Marking Symbols p. 616
Proofreader's Symbols