Technical Writing
The io consulting
Effective Wriring
Listen to the discussion
The quality of the documentation we produce is often a client’s main measurement of the standard of our work. No matter how thorough, robust, or skilful the background technical work performed by individuals and project teams as a whole, this quality relies heavily on how the results of the work are communicated in written form.
In the past, deliverables such as technical reports have been prepared with varying degrees of skill by a variety of methods, including:
-
using individual interpretation of good form for technical writing;
-
‘cutting and pasting’ from similar previous documents;
-
adopting guidelines on good writing style from reference sources.
The result has been one of mixed success. Management has recognised the need to generally improve the quality of written documentation and has introduced a formal programme to introduce effective technical writing as a skill.