How to Write and Present Technical Information

Auteur

Charles H. Sides, PhD, directs the technical communication program at Fitchburg State College. A recognized scholar, he has published seven books and over two dozen articles concerning a wide range of technical and professional communication issues. He was recently appointed executive editor of the Journal of Technical Writing and Communication, the leading international scholarly journal in its field, and editor of the prestigious Baywood Technical Writing Book Series. An active consultant to defense, high-tech, and publications industries, he has worked with clients across the United States, as well as in the Middle East and Far East.

Texte du rabat

Thoroughly updated to discuss the use of tools such as Skype and social media, this concise volume shows how effective communication-via written text and spoken presentations-can positively impact project management in professional environments. Professional communications are the "information product" of all organizations and businesses. Based on that premise, this book offers communications strategies that will benefit any organization that disseminates technical information in-house and/or to customers. The popular work provides easy-to-understand and apply guidelines for designing and writing effective technical documents, as well as other related communications. What makes this new edition especially valuable is that it maintains the quality of information that distinguished the previous editions, but is now updated to encompass current technology and trends, including today's prevalent communication tools such as social media. The book begins by looking at skills common to all technical writing and offering general advice on designing and writing reports. Next is a discussion of specific types of reports along with common problems and issues writers face. Finally, the work overviews other forms of communications such as professional presentations. The updated material also considers the growing importance of interviews and focus groups as information-gathering tools, the influence of visual rhetoric, and the use of technologies such as Skype and webinars.

Contenu

Preface Introduction PART I: WRITER, AUDIENCE, AND DOCUMENTATION 1 Who We Are and What We Do 2 How to Define High-Quality Documentation 3 How to Define Your Audience PART II: GETTING STARTED 4 How to Get Organized 5 How to Get Information with Interviews 6 How to Explain Your Subject 7 How to Use Graphics with Reports and Papers 8 How to Use Writing Tools PART III: HOW TO WRITE A PAPER OR REPORT 9 How to Organize a Paper 10 How to Write the Discussion or Body of an Article 11 How to Write the Exit 12 How to Write the Lead PART IV: HOW TO WRITE SPECIFIC DOCUMENTS 13 How to Write Specifications 14 How to Write Procedures 15 How to Write Proposals 16 How to Write Analysis Reports 17 How to Write Product Descriptions PART V: HOW TO WRITE AND DESIGN FOR DIGITAL MEDIA 18 How to Use the Internet in Professional Environments 19 How to Design and Write for Mutlimedia Applications 20 How to Design and Write for Social Media PART VI: HOW TO WRITE AND DESIGN ASSOCIATED COMMUNICATIONS 21 How to Write Public Relations Documents 22 How to Write Marketing and Advertising Documents 23 How to Design Training Programs PART VII: FINISHING YOUR WORK 24 How to Avoid Common Writing Problems 25 How to Edit and Revise Your Work PART VIII: PRESENTATIONS AND MEETINGS 26 How to Make Professional Presentations 27 How to Use Visuals with Presentations 28 How to Run Effective Meetings PART IX: CONCLUSION 29 Final Thoughts Index