Difference between revisions of "Definitions and Descriptions"
Line 1: | Line 1: | ||
− | {{ | + | {{3040Topic|Introduction= |
+ | When writing you have to be sure that your reader understands the terms and topics you are writing about. By properly using ''Definitions'' and ''Descriptions'' you can be sure that your audience is always aware of what is being writen about. In this section you will learn about what Definitions and Descriptions are and how they will help you write better.}} | ||
== Overview == | == Overview == |
Revision as of 13:39, 8 April 2008
COMP3040 > Back to Chapter Topics
Introduction
When writing you have to be sure that your reader understands the terms and topics you are writing about. By properly using Definitions and Descriptions you can be sure that your audience is always aware of what is being writen about. In this section you will learn about what Definitions and Descriptions are and how they will help you write better.
Contents
|
...by studentsOverviewNow that you know what this chaper is all about lets get into what defintions and descriptions are. DefinitionsDefinitons are technical terms known only to those in your profession. DescriptionsDescriptions are a way of explaing the steps in a process in a way that the reader understands how to do that process. This is often confused with an instruction which is a way of describing a sequence of steps in a process so that the reader can perform those steps. Writing Good DescriptionsKnow your audienceKnowing your audience when writing proper decriptions is key. You should ask yourself several questions before you start writing: (Textbook citation)
Considering who you will be writing for will make sure you write something that is understandable for everyone. Remember when writing for an audience that is of mixed backgrounds that you should write for the members of the audience with the least amount of knowledge. In this way you will be sure that everyone that is to read your descriptions can understand them. Follow the ABC formatThe ABC format (Abstract / Body / Conclusion) should be followed when writing a description.
Use an objective point of viewRemember that when you are writing a description you are explaining to a user the list of steps involved in a process, not telling them how to do it. Steps in descriptions should not be written in the personal point of view. Example - Objective point of view: The carpenter then cuts the wood. - Personal point of view You should then cut the wood. Choose the right amount of detailRemember to consider who you are writing for to determine how much detail you really need to include when writing descriptions. ExamplesCommon MistakesWriting Good DefinitionsEven the best written document would be nothing without proper defintions. Without defintions readers will be left wondering of the meaning of certain techinical terms. When writing definitions you should use the following guidelines. Keep it simpleWhen writing a definition keep it simple. Writing a defintion that is overly long with other technical terms in it is just going to defeat the purpose of writing that definition in the first place. When writing a definition there are three formats you can choose from. 1. Informat Definition Very brief. This is often in parentheses right by the word being defined. 2. Formal Definition This is a full sentence. 3. Expanded Definition This is the most lengthy of the three formats to choose from. This type of definition may be a paragraph or more.
Example=== Common Mistakes === |