Writing for the Technical Professions: International Edition (4e)

Writing for the Technical Professions introduces technical writing in the context of the problem solving, multi-genre-writing demands of the actual technical workplace. 

 

This concise and compelling text emphasizes problem solving techniques for communication situations that technical professionals encounter every day and is intended as a comprehensive primary text for introductory technical communication courses.  Its hands-on, practical approach to writing and design make it a useful reference tool.

Each chapter concludes with “Quick Review,” “Exercises,” and “Community Action Project” sections.

Preface.

Introduction.

What Are the Technical Professions?

What Is Technical Communication?

Who Is the Typical Technical Communicator?

What Skills Do Technical Communicators Need?

How Can This Book Help You?

Why Choose to Do Community Action Projects?

 

I. BASIC TOOLS.

1. Planning.

Developing a Rhetorical Strategy.

Problem-solving Strategies for Technical Communicators.

Analyzing Your Audience.

Specific Planning Techniques.

Considering the Ethical Dimensions of a Project.

Tips for International Communication.

 

2. Researching.

Researching to Solve a Problem.

Researching to Understand a Product.

A Systematic Approach to Research.

Finding and Evaluating Sources.

Planning and Conducting Interviews.

Designing Questionnaires.

Using Research to Support Your Document.

Avoiding Plagiarism.

Documenting Sources.

Tips for International Communication.

 

3. Organizing for Readers.

Setting Reader Expectations (Frontloading).

Dividing Information into Units (Chunking).

Organizing Sections.

Paragraphing Effectively.

Tips for International Communication.

SAMPLE DOCUMENT.

 

4. Designing the Document: Format and Graphics.

Understanding Visual Design Principles.

Designing Readable Hardcopy Pages.

Deciding When to Use Graphic Illustrations.

Choosing Appropriate Graphics.

Tips for International Communication.

Technology Challenge

 

5. Editing for Style.

Creating a Readable Style.

Controlling Wordiness.

Writing Smooth Transitions.

Pacing.

Considering the Ethics of Style.

Tips for International Communication.

Technology Challenge

 

6. Collaborating on Writing Projects.

The Collaborative Process.

The Individual Contributor.

The Project Manager.

Phases of the Project.

Tracking the Project.

Establishing Effective Communication.

Conflict and Mediation.

Tips for International Communication.

 

7. Communicating with Other Cultures

Technical Communication Tasks in the Global Workplace

Culture as More than Stereotype

Key Focus Areas of Cultural Difference

Eastern and Western Thinking Patterns

Collaborating on Multicultural Teams

Guidelines for Collaborating with Email

 

8. Considering Ethical and Liability Issues.

Ethics Defined.

Social Responsibility.

Types of Ethical Issues.

Guidelines for Ethical Choices.

Information Liability.

Understanding Product Liability Law.

Liability in Writing Marketing Material.

Liability in Writing Safety Information.

Liability in Writing Employee Information.

Understanding Intellectual Property Law.

Tips for International Communication.

 

II. PROFESSIONAL APPLICATIONS.

9. Memos, Letters, and E-mail Correspondence.

Comparing Correspondence Modes.

Planning and Researching.

Organizing.

Designing.

Editing.

E-mail.

Tips for International Communication.

SAMPLE DOCUMENTS.

 

10. Instructions, Procedures, and Policies.

The Difference Between Instructions, Procedures, and Policies.

Planning and Researching.

Organizing.

Designing.

Editing.

Testing for Usability.

Tips for International Communication.

SAMPLE DOCUMENTS.

 

11. Describing and Summarizing Technical Information.

Planning and Researching.

Organizing.

Designing.

Editing.

Tips for International Communication.

SAMPLE DOCUMENTS.

 

12. Abstracts and Executive Summaries.

Planning and Researching.

Organizing.

Designing.

Editing.

Tips for International Communication.

SAMPLE DOCUMENTS.

 

13. Reports.

Communicating Factual Information.

Planning and Researching.

Organizing.

Designing.

Editing.

Tips for International Communication.

SAMPLE DOCUMENTS.

 

14. Proposals.

An Overview of Proposal Writing.

Planning and Researching.

Organizing.

Designing.

Editing.

Following Up the Proposal Submission.

Tips for International Communication.

SAMPLE DOCUMENTS.

 

15. Electronic Media: Online Help, Website Design, and Blogs.

Understanding the Differences Between Online and Print Media.

Planning and Researching.

Organizing.

Designing.

Developing and Designing a Blog.

Editing.

Tips for International Communication.

Technology Challenge

SAMPLE DOCUMENTS.

 

16. Flyers, Brochures, and Newsletters.

Understanding Marketing Writing.

Planning and Researching.

Organizing and Designing.

Editing.

Tips for International Communication.

Technology Challenge

 

17. Professional Presentations.

Planning and Researching.

Organizing.

Designing.

Editing.

Tips for International Communication.

Technology Challenge

SAMPLE DOCUMENT.

 

18. Finding a Job.

Understanding Job Application Protocol.

Organizing the Search.

Writing Job Application Letters.

Writing Resumes.

Preparing Professional Portfolios.

Interviewing.

Following Up.

Tips for International Communication.

Technology Challenge

SAMPLE DOCUMENTS.

 

A Quick Guide to Grammar and Punctuation.

Avoiding Ambiguity.

Using Parallel Structure.

Using Consistent Verb Tenses.

Using Commas and Semicolons.

Using Hyphens.

Punctuating Lists.

ESL (English as a Second Language) Considerations.

Glossary of Usage.

 

Index.

• A new chapter on communicating globally explores the challenges of working in a global context, as most technical communicators must now do.
• More, and varied, sample documents of both professional and student work appear in the richly annotated clusters at the end of Part 2 chapters and at the end of the book.
• Coverage of the electronic workplace has been expanded to include a new focus on blogs, an updated chapter on electronic design and media, and more material on researching online.
• Task-oriented strategies for handling real-world situations appear throughout, gathered into three useful categories:  Guidelines, which provide brief summaries of strategies and techniques; Checklists, which allow readers to evaluate the necessary components of specific projects; and Steps to…, numbered lists that take readers step-by-step through processes of technical communication.

• A unique comb-bound format with handy tabbed dividers enables readers to effortlessly locate the needed information.   
• Substantive, real-world examples and sample documents from such disciplines as engineering, the health sciences, software design, and biotechnology are illustrated throughout the text.
• More than thirty annotated sample documents appear in the chapters of Part Two, and others appear throughout the book.
• The need for on-the-job critical thinking to apply viable strategies and to grasp the rhetorical context of a document is repeated throughout the text.
• Task-oriented strategies are provided in comprehendible guidelines and checklists for a wide variety of tasks in planning, drafting, designing, and editing technical documents and for engaging with other writers collaboratively.
• A focus on the electronic workplace brings students into the issues of contemporary technical communication.
• An emphasis on project management and collaboration reflects the collaborative workplace and offers guidance on specific issues like scheduling, tracking, conducting meetings, and negotiating differences.
• An emphasis on ethics and legality–particularly the implications of individual, environmental, corporate, and global decisions, actions, and language–provides insight into an increasingly critical area. 
• End-of-chapter “Community Action” projects suggest ways that students can use technical communication genres to develop real projects in their local neighborhoods or communities.
• “Tips for International Communication” appear at the end of every chapter, and examples pertaining to global communication are threaded throughout the text.
• A Quick Guide to Grammar and Punctuation offers students a mini-handbook for continued reference.