October 23, 2020
Characteristics of Effective Technical Content
Effective technical communication helps the users find the relevant information quickly, and enables them to be effective and efficient.
October 23, 2020
Consistency: Using Style Guides
In an earlier post, Characteristics of Effective Technical Content, we listed predictability as being one of the characteristics of effective technical content. Consistency is the key to predictability. In today’s globalised world, organizations could have multiple technical writers working different pieces of documentation. However, at the end of the day, the…
The Elements of Style – A Rap Version
Keep It Short and Simple (KISS) is an oft-heard refrain in technical writing. William Strunk, Jr. says it best in his seminal book, The Elements of Style, when he writes: Vigorous writing is concise. A sentence should contain no unnecessary words, a paragraph no unnecessary sentences, for the same reason…
