Part 2Easy to understand
Whether technical information is easy to understand depends mainly on how it is presented at the level of small structures such as words and sentences. It can also involve larger structures such as examples and scenarios.
Use words with a clear meaning
Make the syntax of sentences clear
Remove roundabout expressions and needless repetition
Get Developing Quality Technical Information: A Handbook for Writers and Editors, Second Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.