Clear and concise technical writing

Technical writing requires a balance between brevity and clarity. A few simple tricks can help to enhance the meaning of a short text without lengthening it significantly.

Text by Susan Grimmette

Inhaltsübersicht

Clear and concise technical writing

Image: © Joe Belanger/ 123rf.com

Particularly on computer screens, space is limited and often created with the KISS principle in mind: keep it short and simple. Clarity might take a backseat to allow for shorter texts.

In this article I give examples of abbreviations, mainly from computing, to suggest some simple improvements. Some of the examples may confuse readers, particularly when taken out of context. My aim is to alert you to possible inconsistencies, so that you can look out for possible ambiguities in your own writing. Recognizing that there is a problem is the first step towards seeking a solution.

Take the reader’s viewpoint

In my view, the most important thing about good technical writing is to address the viewpoint of your readers. Do not assume that your readers share the point of view of the person who gave you the information (usually a product developer, such as an engineer or a computer programmer). ...