If you’ve never partnered with a technical writer to create essential documentation or sat down with an instructional designer to develop impactful training, it can be tough to know what to expect. Even if you have, these projects require...
Effective infographics can say more with a picture than a thousand words. So how can technical writers use infographics most effectively? Although we’ve blogged about infographics before in the post Infographics: Information at a Glance, we’ve never applied them...
iinfographic assembly guide, infographic diagram, infographic flow chart, infographic map, infographics, infographics in tech comm, technical documentation, technical writing, technical writing infographics
Historically, technical writers worked with one product from start to finish. That meant beginning with an outline for the product or piece of equipment, writing the content, and then formatting it for delivery. In some industries, technical communication is...
benefits of collaborative environment, collaboration in tech writing, collaborative technical writing, drawbacks to collaboration, tech comm, technical writing
User guides are essentially a set of instructions. Most user guides contain standard style and formatting techniques. These guidelines ensure consistency and ease of reading. What you include in your user guide will depend on the audience of the...
manuals, technical writing, technical writing best practices, technical writing techniques, Technical Writing Tips, user guide format, user guide style, user guide style and format, user guides
Standard operating procedures (SOPs) not only lead to process improvement, they also improve a company’s overall organization and efficiency. There can be the misconception that SOPs are little more than useless paperwork. However, they offer insights beyond documentation by...
SOPs, Standard Operating Procedures, technical documentation, technical writing, Technical Writing Tips, Tips for Writing SOPs
If a word is misspelled or misused in a text, it distracts the reader from your content. The same is true for the way you use numbers in your documents. Are there 6 spark plugs in a set or...
by the numbers, documentation, numbering in documentation, numbers in text, technical writing, technical writing best practices, writing
Not everyone is fortunate enough to have an editor to check what we write before it goes to the client or is put in front of the audience. Editing your own writing is difficult because our brains know what...
It does not matter if you are an instructional designer or a technical writer. Understanding how people learn is important if you want your audience to remember the information you provide. My company, Radcom, hosts a monthly book club,...
A few months ago I wrote an introduction to Standard Technical English (STE). Check it out if you want to get a better idea of the history, uses, and benefits of STE. The following article is a visual representation...
Are you struggling with creating a knowledge transfer strategy? Or is the current strategy unsuccessful and you don’t know why? The folks at Ed Threads created a playbook for creating a successful eLearning strategy, but it can also be...