Video: 15 Technical Writing Tips

In this video Ivan shares 15 ways to improve your technical writing. He shows how to design better documents, perform better peer reviews, and write that little bit faster… without reducing the quality of your documents. If you have a question, please leave it on the YouTube channel. 15 Technical Writing Tips Our User Guide […]

How to Write Your First Technical Documentation Plan

Use the following guidelines to plan, schedule, and writer the user and support technical documentation for your next software product. Examples of this documentation include user guides, admin manuals, online help, and release notes. Preparing a Documentation Plan involves several different activities. Let’s examine what’s involved. Work Breakdown Structure Template [Learn more about this template here] Depending on the complexity […]

14 Screenshot Guidelines for Technical Documents

The purpose of screenshots is to compliment the text, not replace it. This means that your screenshots compliment what you’ve written and help orient the reader. They also help reduce anxiety in the reader as they can check if they are on the right window. What to capture Identify where the user needs to perform […]

How to Fix Corrupt MS Word Documents

Last week we showed you how Bullet Lists can crash MS Word. We outlined some techniques to reduce the file size, mostly by creating pre-formatted bullet lists in advance. But what happens if you’re given a User Guide that’s already bloated to massive proportions. It’s too late to create new styles at this stage. Here’s […]

7-Step Approach to Proofreading User Guides

What can Kate Winslet teach you about proof-reading technical documents? Watch the movie The Reader and it will make sense. One of the biggest mistakes you can make when revising any technical document, is to do it all in one go. You can’t! 7 Ways to Proofread User Guides Make it easy on yourself and […]

How to Stop MS Word Files From Crashing

If your Microsoft Word files suddenly become huge and start crashing, here’s how to fix it. Sometimes MS Word files explode from 1 to 10 MB in a few minutes? Why? Why Bullet Lists Creates Large MS Word files? The first offender is Bullet Lists. If there is one thing that’s guaranteed to crash Microsoft […]