| |
| |
Planning and Revision Checklist | |
| |
| |
How to Use Reporting Technical Information | |
| |
| |
Preface | |
| |
| |
| |
An Overview of Technical Writing | |
| |
| |
The Matter of Definition | |
| |
| |
Writing at Work versus Writing at School | |
| |
| |
Writing and Communicating at Work | |
| |
| |
The Foundations of Effective Technical Writing | |
| |
| |
The Qualities of Good Technical Writing | |
| |
| |
Exercises | |
| |
| |
| |
Foundations | |
| |
| |
| |
Composing | |
| |
| |
The Basic Parts of the Composing Process | |
| |
| |
Using the Composing Process in a Workplace Environment | |
| |
| |
Understanding the Composing Process: Why Bother? | |
| |
| |
Exercises | |
| |
| |
| |
Writing for Your Readers | |
| |
| |
Goals of Communication | |
| |
| |
The Planning Process | |
| |
| |
Thinking about Your Readers: A Summary of Considerations | |
| |
| |
Exercises | |
| |
| |
| |
Achieving a Readable Style | |
| |
| |
The Paragraph | |
| |
| |
Basic Principles of Effective Style | |
| |
| |
The Sentence | |
| |
| |
Exercises | |
| |
| |
| |
Writing Ethically | |
| |
| |
Ethical Perspectives | |
| |
| |
Your Professional Obligations | |
| |
| |
Codes of Conduct | |
| |
| |
Recognizing Unethical Communication | |
| |
| |
Anticipating Consequences | |
| |
| |
Applying Principles | |
| |
| |
Handling Unethical Situations | |
| |
| |
Exercises | |
| |
| |
| |
Writing for International Readers | |
| |
| |
Establishing a Perspective on International Communication | |
| |
| |
Understanding Readers from Various Cultures | |
| |
| |
Considering Culture in the Planning Process | |
| |
| |
Example International Documents | |
| |
| |
Writing Business Communications to Readers in Other Cultures | |
| |
| |
Culture and Graphics | |
| |
| |
Format Strategies in Other Cultures | |
| |
| |
A Final Word | |
| |
| |
Guides to Doing Business in Cultures around the World | |
| |
| |
Exercises | |
| |
| |
| |
Techniques | |
| |
| |
| |
Gathering, Evaluating, and Documenting Information | |
| |
| |
Asking Productive Questions | |
| |
| |
Looking for Answers | |
| |
| |
Evaluating Answers | |
| |
| |
Citing Sources | |
| |
| |
Exercises | |
| |
| |
| |
Designing and Formatting Documents | |
| |
| |
Understanding the Basics of Document Design | |
| |
| |
Designing Effective Pages and Screens | |
| |
| |
Choosing Readable Type | |
| |
| |
Helping Readers Locate Information | |
| |
| |
Designing Web Sites | |
| |
| |
Testing Your Design | |
| |
| |
Exercises | |
| |
| |
| |
Creating and Managing Text | |
| |
| |
Collecting and Grouping Information | |
| |
| |
Planning Content Development | |
| |
| |
Strategies for Developing Content | |
| |
| |
Organization and Content Development | |
| |
| |
Other Types of Development | |
| |
| |
Exercises | |
| |
| |
| |
Developing the Main Elements of Reports | |
| |
| |
Prefatory Elements | |
| |
| |
Abstracts and Summaries | |
| |
| |
Discussion or Body of the Report | |
| |
| |
Online Reports | |
| |
| |
Exercises | |
| |
| |
| |
Creating Tables and Figures | |
| |
| |
Choosing Illustrations | |
| |
| |
Creating Illustrations | |
| |
| |
Designing Illustrations Ethically | |
| |
| |
Exercises | |
| |
| |
| |
Applications | |
| |
| |
| |
Planning Correspondence and E-Mail | |
| |
| |
Determining Your Purpose | |
| |
| |
Analyzing the Audience | |
| |
| |
Composing Letters, Memos, and E-Mail | |
| |
| |
Finding the Appropriate Style | |
| |
| |
Special Considerations for E-Mail | |
| |
| |
Special Considerations for International Correspondence | |
| |
| |
Keeping Copies of Correspondence | |
| |
| |
Exercises | |
| |
| |
| |
Creating Reports for Any Occasion | |
| |
| |
The Variable Nature of Reports | |
| |
| |
Liability and Report Writing | |
| |
| |
General Report Requirements | |
| |
| |
Determining Report Structure | |
| |
| |
Determining Internal Report Development | |
| |
| |
Importance of the Introduction and Summary | |
| |
| |
The Online Report | |
| |
| |
The Slide/Visual Presentation Report | |
| |
| |
Exercises | |
| |
| |
| |
Developing Analytical Reports: Recommendation Reports and Feasibility Studies | |
| |
| |
Analytical Reports | |
| |
| |
Recommendation Reports | |
| |
| |
Feasibility Studies | |
| |
| |
Environmental Impact Statements | |
| |
| |
Exercises | |
| |
| |
| |
Developing Empirical Research Reports | |
| |
| |
Major Sections of Empirical Research Reports | |
| |
| |
Other Examples for Analysis and Comparison | |
| |
| |
Exercises | |
| |
| |
| |
Writing Proposals and Progress Reports | |
| |
| |
The Relationship between Proposals and Progress Reports | |
| |
| |
Proposals | |
| |
| |
Progress Reports | |
| |
| |
Physical Appearance of Proposals and Progress Reports | |
| |
| |
Style and Tone of Proposals and Progress Reports | |
| |
| |
Other Forms of Proposals and Progress Reports | |
| |
| |
Exercises | |
| |
| |
| |
Formulating Instructions, Procedures, and Policies | |
| |
| |
Planning Instructions and Procedures | |
| |
| |
Structure and Organization | |
| |
| |
Theory Governing the Procedure or Instruction | |
| |
| |
Conditions under Which the Task Is to Be Performed | |
| |
| |
Steps in Performing the Task | |
| |
| |
Procedures | |
| |
| |
Policies | |
| |
| |
Exercises | |
| |
| |
| |
Writing Collaboratively | |
| |
| |
Issues in Collaboration | |
| |
| |
Value of Collaboration | |
| |
| |
Techniques for Developing Collaborative Documents | |
| |
| |
Making Collaborative Projects Work | |
| |
| |
Collaborative Projects in Action | |
| |
| |
Exercises | |
| |
| |
| |
Preparing Oral Reports: The Basics | |
| |
| |
Understanding the Speaking/Writing Relationship | |
| |
| |
Analyzing the Audience | |
| |
| |
Analyzing the Context | |
| |
| |
Determining the Goal of Your Presentation | |
| |
| |
Choosing and Shaping Content | |
| |
| |
Deciding How to Arrange and Organize the Content | |
| |
| |
Designing Each Segment: Guidelines | |
| |
| |
Choosing an Appropriate Speaking Style | |
| |
| |
Speaking to Multicultural Audiences | |
| |
| |
Using Techniques to Enhance Audience Comprehension | |
| |
| |
Planning Visuals to Enhance Your Purpose and Your Meaning | |
| |
| |
Designing and Presenting the Written Paper | |
| |
| |
Speaking Effectively: Practice, Practice, Practice | |
| |
| |
Exercises | |
| |
| |
| |
Understanding the Strategies and Communications of the Job Search | |
| |
| |
Preparation | |
| |
| |
The Correspondence of the Job Search | |
| |
| |
Interviewing | |
| |
| |
Exercises | |
| |
| |
| |
Handbook | |
| |
| |
Index | |
| |
| |
About the Authors | |
| |
| |
Marking Symbols | |
| |
| |
Proofreader's Symbols | |