Difference between revisions of "Definitions and Descriptions"
(→Writing Good Definitions) |
|||
Line 12: | Line 12: | ||
== Writing Good Definitions == | == Writing Good Definitions == | ||
− | Even the best written document would be nothing without proper definitions. Without definitions readers will be left wondering of the meaning of certain technical terms. Including definitions when writing lets readers of less technical backgrounds know what more advanced terms are. Readers that are more advanced also benefit because they can go back and reference terms that they | + | Even the best written document would be nothing without proper definitions. Without definitions readers will be left wondering of the meaning of certain technical terms. Including definitions when writing lets readers of less technical backgrounds know what more advanced terms are. Readers that are more advanced also benefit because they can go back and reference terms that they aren't completely sure of. When writing definitions you should use the following guidelines. |
====Keep it simple ==== | ====Keep it simple ==== |
Revision as of 14:01, 9 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 always understands what you're writing 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 chapter is all about lets get into what definitions and descriptions are. DefinitionsDefinitions are technical terms known only to those in your profession. DescriptionsA good way to explain what a description it to say it is like an expanded definition. Writing Good DefinitionsEven the best written document would be nothing without proper definitions. Without definitions readers will be left wondering of the meaning of certain technical terms. Including definitions when writing lets readers of less technical backgrounds know what more advanced terms are. Readers that are more advanced also benefit because they can go back and reference terms that they aren't completely sure of. When writing definitions you should use the following guidelines. Keep it simpleWhen writing a definition keep it simple. Writing a definition 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. There are three formats you should choose from when writing definitions. 1. Informal 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.
ExampleNow that you know the types of formats you should choose when writing a defintion how do you decide which one to use?
Example You can use a browser (Software that alows you to view pages on the internet) to make deposits into your online banking account. As you see here the definition comes right after the word being defined. It is short and to the point.
Example A web browser is a computer program that allows a user to view pages on the internet.
Common MistakesWriting Good DescriptionsKnow your audienceKnowing your audience when writing proper descriptions 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. Accuracy is keyBeing accurate when writing a description lets the reader understand what you are trying to describe. 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. Have an Organization PlanUse of Analogies and GraphicsVisualizing TestA sure fire way to test the effectiveness of the description you have just written is to give it the visualizing test. Read your description to someone who is not familiar with the topic you wrote about. If that person can draw a rough sketch of what you are describing then you have a good description. Examples==== Common Mistakes ==== |