Technical writing requires clarity of expression and therefore simplicity of language. Technical writing is intent on expressing certain key concepts so that these may be understood as easily as possibly by the intended readers — be they programmers or users. Writing in a clear, concise manner makes not only understanding the text easier for the reader, it also makes your life as a writer of technical documentation easier — especially when you are not a native speaker of English. | Technical Notes general Series Technical Writing made easier rev. March 2002 by Bernhard Spuida bernhard@ Senior Word Wrangler Bernhard Spuida 2002 1 Table of Contents 1. 2. 3. Well formed Overlong Short Choice of 4. Assumption Explanation 5. Matters of Big It An a .9 Do not use don t .9 Can could Ego When to use if .10 This Sentence does overdo Time is on our Editor s pet Grammar and Spelling and 6 Recommended 7 Online Bernhard Spuida 2002 2 1. Introduction Technical writing requires clarity of expression and therefore simplicity of language. Technical writing is intent on expressing certain key concepts so that these may be understood as easily as possibly by the intended readers be they programmers or users. Writing in a clear concise manner makes not only understanding the text easier for the reader it also makes your life as a writer of technical documentation easier especially when you are not a native speaker of English. When talking about algorithms or sequences of events in a program absolute clarity of writing is not only needed in the code discussed but also in documenting this particular program for our fellow programmers and users. We need to attain the same level of clarity of expression in both cases otherwise readers will to turn to other programs which are more accessible on the level of understanding and therefore easier to use or extend. In this short guide we will cover some of the basic concepts that lead to good technical writing. You will certainly discover more such rules and concepts as you practice the writing skills .
