Shanghai Tech WriterTechnical Writing, Technology, Web2.0, Google, Shanghai, China

(Guest post by Kelly Kilpatrick)

Technical writing can be a very interesting endeavor. As tech writers, we need to take complex information and turn it into something that the average reader can make sense of. Often, the directions and specifications we must work with were written by people who are very skilled at engineering or another technological profession; technical writers use a few tactics to make this information more easily digestible. Take a look at the following ways we as technical writers achieve this goal.

Authoritative Voice

When people read technical writing, they are looking for information from an authority on the subject. It is important to convey to the reader that the information is both useful and accurate. Expert-level information combined with readability for the average reader will convey the message clearly and accurately, benefiting all parties.

Explanation of Key Terms

Keep in mind that your readers may not understand all of the technical jargon that you may need to use in order to get your message across. Take time to explain the key terms and what they mean, either before you get started or as you come across these words and phrases. Doing this will eliminate any barriers for readers and help your copy to do its job.

Diversify Your Delivery

When creating technical documentation, make sure that you diversify the way the information is delivered to the reader. Incorporate appropriate graphics, bullet information, and vary the length of paragraphs, etc. This will help keep their attention and make sure that the finer points are clarified in the process.

Lead the Reader

Use headings, sub headings, and other signposts to show your reader where to go and what to read next. If they are looking for a specific piece of information, make sure that it is easy enough to find without having to read the entire document. Lead the reader through what you have written by making things easy to find and clearly labeled and identified.

Keep it Clear and Concise

There is no reason to get overly wordy with technical writing. Get to the point and state things clearly in layperson’s terms. The average reader just wants the relevant information, not a bunch of fluff; give the reader what they want and keep it brief and to the point.

This post was contributed by Kelly Kilpatrick, who writes on the subject of best online technology degrees. She invites your feedback at kellykilpatrick24 at gmail dot com