Advanced Technical Writing City Tech February 2015 EXPANDED DEFINITIONS

Most controversies would soon be ended, if those engaged in them would first accurately define their terms, and then adhere to their definitions.  Tryon Edwards I am very much afraid of definitions, and yet one is almost forced to make them. One must take care, too, not to be inhibited by them.  Robert Delaunay

Why definitions?

 Poor documentation can cost money:  in customer support calls  wasted engineering efforts during collaboration  missed deadlines  legal issues (project scope, deliverables) POOR DOCUMENTATION

 Research and gather information  Become an expert on this word/phrase CHOOSING A WORD

 Tell readers what term is being defined.  Present clear and basic information.  Use facts, examples, or anecdotes that readers will understand. 3 SIMPLE STEPS

 Term to be defined  Sentence definition of the term  Reason(s) for giving a more detailed definition  The kinds of additional information that will be used to extend the definition INTRODUCTION

WRITE THE FORMAL SENTENCE DEFINITION

 What is the object or concept I want to define?  What general category does the subject fall into?  What distinguishing characteristics does it have?  Can I compare it to something similar to help define it?  Can I explain it by saying what it is not?  Why am I defining this subject and for what purpose?  What do I want my readers to learn or understand? QUESTIONS TO CONSIDER

 MEANINGS Have you explored your subject fully, turning up both its obvious and its not-so-obvious meanings?  METHODS OF DEVELOPMENT Have you used an appropriate range of other methods to develop your subject?  THESIS Have you focused your definition and kept within that focus, drawing clear boundaries around your subject?  EVIDENCE Is your definition specific? Do examples, anecdotes, and concrete details both pin the subject down and make it vivid for readers?  UNITY Do all paragraphs focus on your thesis, and do individual paragraphs or groups of paragraphs focus on parts of your definition? REVISING

A word expanded definition of a technical or scientific term, with cover memo, which demonstrates 1. correct memorandum format. 2. knowledge of the etymology and historical development of the term. 3. examples of the term's use in various contexts. 4. ability to compare and contrast various uses of the term. 5. use and citation of sources with proper attribution. 6. awareness of audience. ASSIGNMENT