Difference between revisions of "Definitions and Descriptions"
| Line 9: | Line 9: | ||
== Writing Good Descriptions == | == Writing Good Descriptions == | ||
| − | 1. Know your audience. | + | =====1. Know your audience.===== |
| + | |||
Knowing your audience when writing proper decriptions is key. You should ask yourself several questions before you start writing: (Textbook citation) | Knowing your audience when writing proper decriptions is key. You should ask yourself several questions before you start writing: (Textbook citation) | ||
- How much detail are you supposed to include in your description? | - How much detail are you supposed to include in your description? | ||
Revision as of 13:48, 3 April 2008
Contents
Overview
Definitions
Definitons are technical terms known only to those in your profession.
Descriptions
Descriptions 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 Descriptions
1. Know your audience.
Knowing your audience when writing proper decriptions is key. You should ask yourself several questions before you start writing: (Textbook citation)
- How much detail are you supposed to include in your description? - What is the technical background of the persons who will be reading your description? - Are all the readers of the same techinical background?
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.
2. Follow the ABC format.
The ABC format (Abstract / Body / Conclusion) should be followed when writing a description.
In the Abstract you should include: - A summary of your topic. - You should also answer the five W's. (Who, What, Where, When, Why)
In the Body you should include: - Step by step process that moves through the steps involved in the process. This can be done either by writing a paragraph or by having a list of steps.
In the conclusions - Conclude the entire process. - This section helps end the description without just stopping with the last step in the process.
3. Use an objective point of view.
Remember 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.
Examples - Objective point of view The carpenter then cuts the wood. - Personal point of view You should then cut the wood.
4. Choose the right amount of detail.
