Tuesday, April 21, 2015

Effective Technical Communication Style

On any given day, a technical communicator may work on writing user guides, designing flowcharts, developing online content, editing procedures, contributing to marketing assets, developing technical illustrations and directing translators. And that's only a few of a technical communicator's responsibilities. The action is juggling, but the concept is simple: show and tell the customer or end-user accomplish something.


Definition


Technical communication is the art of telling people accomplish something in the simplest, most efficient and accurate way possible.


Knowledge Is Power


Use every minute of time available to consult with subject matter experts (SMEs) on your technical communication at hand. Familiarize yourself with the subject, and then consult with the SMEs, and ask questions. At the same time, understand your audience -- ask corporate or your direct supervisor. Is your audience in the industry or laymen? This affects your subsequent communication style.


Keep It Super Simple


Use simple text. Avoid jargon, even if you think it's implied. If you've followed Section 2, then you know your audience; if your audience is engineers, don't spell out terminology common to them (they know it), but if your audience is consumers (United States or worldwide), find another simple way to explain something or define it for them.


A Picture is Worth a Thousand Words


Visual communication is powerful. Always defer to charts, graphs, diagrams and pictures (to name a few visual mediums) when possible. Vision transcends any language and knowledge barrier, so use it. But when you do, go back to the first sections here and make sure it's simple and free from extra labels and information.


Be Creative


Once you've mastered sections 1 through 4, have fun with it. After all, it's communication, and technical communication style can only come from the technical communicator. And that's you.