This is a very short list of guidelines for technical writing. I usually give this as part of induction to my PhD students. This, by no means, could replace a good book on style, but they are a good start. ========= Each sentence presents one idea. Each paragraph covers one subject. Each section covers one topic. Use subsections when it is needed. Use passive sentences whenever possible. Avoid the use of pronouns such as I, we, etc. and my, our etc. If pronouns are to be used then use plural pronouns such as we, our and us. Follow a logical flow of thoughts starting with a background to the problem, solution proposed, how that solution is used and the results. Qualify assertive statements and facts. As an example, if we take a statement such as ‘it is an important subject’ then the questions are ‘why is it important?’ ‘who said is it important?’ and etc. Avoid using immeasurable words or those difficult to qualify such ...
A key part of research is research tools. These are often categorized into reference management software, typesetting software, analytical systems, programming tools, etc. In all project types, reference management and typesetting software are common tools in writing up the research and a key to productivity. They also often go hand in hand. For example if you are using EndNote, which is a commercial reference management software, it is much more productive to use MS Word. EndNote integrates well in MS Word making referencing, formatting references and managing changes easy. In scientific research, Latex system is often used for typesetting. It provides rich tools to deal with mathematical annotations, algorithms pseudo-code and graphs. To setup a Latex system, you need to have the system itself which acts as a compiler or interpreter. Latex files are text files, ordinary text files, with the text tagged in similar way to HTML pages. The Latex system interprets these tags into a ty...