Technical Communication A Practical Approach Chapter 7 Definitions

Definitions and Descriptions n n n Definitions versus Descriptions Guidelines for Writing Definitions Guidelines

Definitions versus Descriptions n n n Define Concepts Describe Objects Descriptions Often Begin with

Guidelines for Writing Definitions n n Keep It Simple Use Informal Definitions for Simple

Guidelines for Writing Definitions n Formal Definitions Technical Communication: A Practical Approach, Eighth Edition

Guidelines for Writing Definitions n Use the ABC Format for Expanded Definitions n Abstract

Guidelines for Writing Definitions n Use the ABC Format for Expanded Definitions n Body

Guidelines for Writing Definitions n Use the ABC Format for Expanded Definitions n Conclusion

Guidelines for Writing Descriptions n n Remember Your Readers’ Needs Be Accurate and Objective

Guidelines for Writing Descriptions n Choose an Overall Organization Plan n n Description of

Guidelines for Writing Descriptions n Give Your Description the “Visualizing Test” n Ask someone

Slides: 11

Download presentation

Technical Communication A Practical Approach Chapter 7: Definitions and Descriptions William Sanborn Pfeiffer Kaye Adkins

Definitions and Descriptions n n n Definitions versus Descriptions Guidelines for Writing Definitions Guidelines for Writing Descriptions Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 2 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Definitions versus Descriptions n n n Define Concepts Describe Objects Descriptions Often Begin with Short Definitions Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 3 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Definitions n n Keep It Simple Use Informal Definitions for Simple Terms n n Single-word synonyms or short phrases Use Formal Definitions for Complex Terms n n Class of similar items Features that separate the item from all other items in the classification Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 4 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Definitions n Formal Definitions Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 5 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Definitions n Use the ABC Format for Expanded Definitions n Abstract n n Includes formal sentence definition Provides overview of how the definition will be expanded Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 6 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Definitions n Use the ABC Format for Expanded Definitions n Body n n n Provides supporting information Uses headings and lists to help reader Expand definition with n n n Background or history Applications Comparison/contrast Basic principles Illustration Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 7 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Definitions n Use the ABC Format for Expanded Definitions n Conclusion n n Reminds reader of the importance of the definition Choose the Right Location for Your Definition n Same sentence Separate sentence Footnote, glossary, or appendix Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 8 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Descriptions n n Remember Your Readers’ Needs Be Accurate and Objective n Include only opinions n n n Based on your professional background Justified by the time you have had to complete the description Supported by details from the site or object being described Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 9 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Descriptions n Choose an Overall Organization Plan n n Description of the parts Description of the functions Description of the sequence Use “Helpers” Like Graphics and Analogies n n Graphics should be explained in the text Analogies explain an new concept in terms of something familiar Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 10 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.

Guidelines for Writing Descriptions n Give Your Description the “Visualizing Test” n Ask someone to use your description as a guide to sketching the object Technical Communication: A Practical Approach, Eighth Edition W. S. Pfeiffer and K. Adkins 11 Copyright © 2013, 2010, 2006 Pearson Education, Inc. , All Rights Reserved.