Technical writing is often an unspoken, and sometimes unheard of, process across business and technology sectors. Many leading R&D centers are bursting with bright spark engineers, sharp-minded designers, and idea generators who make products and services come to life. However, this doesn’t mean that they can explain their product or service accurately or concisely.
Simply put, technical writers produce documentation to help the average reader understand how to use products or services. Few in our field attain fame for their writing, and those who do – like Ted Chiang, Kurt Vonnegut, and Amy Tan – are generally known for their non-technical work. Find out more about technical writing.
Technical writing differs from other forms of writing. Its aim is generally to provide instruction about a subject to help users solve problems. Because technical writing has such a unique, defined goal, good technical writing adheres to specific guidelines. Here we look at some of the most important things to avoid when writing technical documents.