Resources
|
Chapter IntroductionTechnical writers must follow a set of instructions and techniques to properly format their documents. First and most important consideration is the overall document layout. Documents should be designed in a way that would allow the reader to effectively reference key points and enhance the decision making process. The component layout should enhance or maintain reader's interest in you document. Proper use of definitions and descriptions ensures that your audience can follow along and are not facing ambiguities. Documents may be used directly by technical personnel to perform their job, therefore it is essential to provide detailed documentation for their operations. Finally, graphical content techniques can be employed to enhance the data presentation and analysis.
|
|
||
If you're here, learning mathematics or a programming language was probably a lot easier than writing. Why is this? Because writing is an art. There is no clear line between right and wrong. If you make a mistake in your code, the compiler tells you or the program crashes. In writing, there are no guarantees a mistake in your writing will be caught in your word processor.
This chapter covers the extra tools you can use to aid and perfect your writing. The Resources section can't write your paper for you, but it can help point you in the right direction.
Common Writing Mistakes
If you're human, you make mistakes. We usually don't repeat the mistakes we make, except those that appear in our writing. Covered here are some of the more common writing mistakes in the hopes that you will be able to weed them out in your own writing.
