Pocket Guide to Technical Writing

by Pfeiffer, William Sanborn

• ISBN13: 9780130476111
• ISBN10: 0130476110
• Edition: 3rd
• Format: Paperback
• Copyright: 2004-01-01
• Publisher: Prentice Hall

Summary

For courses in Technical Writing, Technical Communication, Writing for Technicians, and Business Writing; as well as corporate training seminars in writing. This well-written, practical text serves perfectly as an inexpensive supplement to technical and scientific courses where students need to write documents such as reports, proposals, letters, and memos. Unique in its combination of an alphabetized handbook with brief chapters on organization and efficiency, this handy reference for on-the-job writing gives quick, easy-to-find answers to common writing problems faced in various technical and professional careers.

Table of Contents

The Writing Process: Achieving Speed and Quality	1	(22)
Definition of Technical Writing	1	(4)
Purpose: Getting Something Done	2	(1)
Writer: Conveying Your Knowledge to the Reader	2	(1)
Readers: Understanding Their Diverse Needs	3	(2)
Nine Steps to Better Writing	5	(15)
Write a Brief Purpose Statement	5	(1)
Consider the Obstacles Your Readers Face	6	(1)
Determine Technical Levels of Readers	6	(1)
Determine Decision-Making Levels of Readers	7	(2)
Find Out What Decision-Makers Want	9	(1)
Collect and Document Information Carefully	9	(5)
Write an Outline	14	(1)
Write Your First Draft Quickly	15	(3)
Revise in Stages	18	(2)
Writing in Groups	20	(3)
Get to Know Your Group	20	(1)
Set Clear Goals and Ground Rules	21	(1)
Use Brainstorming Techniques	21	(1)
Agree on a Revision Process	21	(1)
Use Computers to Communicate	22	(1)
Structure: Achieving Order and Design	23	(16)
Basics of Organization	23	(3)
Write Different Parts for Different Readers	24	(1)
Emphasize Beginnings and Endings	24	(1)
Repeat Key Points	25	(1)
ABC Format	26	(5)
The Abstract Gives the ``Big Picture''	29	(1)
The Body Gives Supporting Details	30	(1)
The Conclusion Provides a Wrap-Up	30	(1)
Page Design	31	(8)
Use White Space Liberally	31	(1)
Use Headings and Subheadings Often	32	(2)
Use Lists Frequently	34	(3)
Use Fonts Effectively	37	(2)
Special Topics: Graphics and Oral Presentation	39	(34)
Graphics	39	(19)
Terms in Graphics	39	(1)
Reasons for Using Graphics	40	(2)
General Guidelines	42	(2)
Guidelines for Pie Charts	44	(3)
Guidelines for Bar Charts	47	(4)
Guidelines for Line Charts	51	(2)
Guidelines for Tables	53	(2)
Guidelines for Technical Drawings	55	(3)
Oral Presentations	58	(15)
Guidelines for Preparation and Delivery	58	(8)
Guidelines for Speech Graphics	66	(2)
Guidelines for Overcoming Nervousness	68	(5)
Appendix A: ABC Formats and Examples	73	(62)
ABC Format 1: Positive Letter	74	(2)
Example 1: Positive Letter	75	(1)
ABC Format 2: Negative Letter	76	(2)
Example 2: Negative Letter	77	(1)
ABC Format 3: Neutral Letter	78	(2)
Example 3: Neutral Letter	79	(1)
ABC Format 4: Sales Letter	80	(2)
Example 4: Sales Letter	81	(1)
ABC Format 5: Memorandum	82	(2)
Example 5: Memorandum	83	(1)
ABC Format 6: Instructions	84	(4)
Example 6: Instructions	85	(3)
ABC Format 7: Problem Analysis	88	(3)
Example 7: Problem Analysis	89	(2)
ABC Format 8: Recommendation Report	91	(3)
Example 8: Recommendation Report	92	(2)
ABC Format 9: Equipment Evaluation	94	(3)
Example 9: Equipment Evaluation	95	(2)
ABC Format 10: Lab Report	97	(3)
Example 10: Lab Report	98	(2)
ABC Format 11: Trip Report	100	(2)
Example 11: Trip Report	101	(1)
ABC Format 12: Feasibility Study	102	(3)
Example 12: Feasibility Study	103	(2)
ABC Format 13: Proposal	105	(3)
Example 13: Proposal	106	(2)
ABC Format 14: Progress Report	108	(3)
Example 14: Progress Report	109	(2)
ABC Format 15: Formal Report	111	(17)
Example 15: Formal Report	112	(16)
ABC Format 16: Job Letter and Resume	128	(7)
Example 16: Job Letter and Resume	129	(6)
Appendix B: Writing Handbook	135	(86)
Alphabetized Table of Contents	135	(3)
Topical Table of Contents	138	(83)
Style	138	(1)
Grammar	139	(1)
Usage	139	(82)
Index	221	(5)
Planning Form	226

Excerpts

This little book aims to provide you with a handy reference for on-the-job writing. It does not pretend to be the last word on the subject. There are plenty of longer books to serve that purpose. Instead, it gives you quick, easy-to-read answers to common writing problems you will face in school and on the job. This introduction includes information on the organization of the text, changes in the third edition, and the sources used in writing it. ORGANIZATION OF TEXT ThePocket Guidepresents information on five main subjects, each with its own chapter or appendix: Chapter 1--The Writing Process: Achieving Speed and Quality Chapter 2--Structure: Achieving Order and Design Chapter 3--Special Topics: Graphics and Oral Presentations Appendix A: ABC Formats and Examples Appendix B: Writing Handbook Each section gives you a "jump start" on planning, drafting, or revising when you are rushed to deliver a document. The two appendices will be especially useful for immediate help with writing. Appendix A includes one-page outlines ("ABC Formats") for 16 different types of documents, followed by model examples. Appendix B contains alphabetized entries to assist with questions about style, grammar, and usage. CHANGES IN THE THIRD EDITION Although the third edition retains the same basic structure and content of the previous editions, it does include five main changes: More information in Chapter 1 on audience analysis, with a shod case study that responds to the needs of a complex audience More information in Chapter 1 on conducting research and avoiding plagiarism, with examples of research cards and a list of references New guidelines in Chapter 2 on font selection in page design, with an illustration New guidelines in Chapter 3 on use of technical drawings as graphics, with two illustrations Addition of a Planning Form at the end of the book, to assist writers in preparing thoroughly before beginning a draft With just a few pages added, the book keeps its focus on providing a quick reference guide for (1) classes in technical writing in which only a short text is needed, (2) classes in various technical and scientific fields in which a short book is needed to supplement the main text, and (3) working professionals who want a handy tool for planning, drafting, and editing their writing.