Category: Uncategorized

A simple table of contents in a document can be a powerful tool to help your readers grasp key concepts and principles as well as find the detail they need. There are plenty of how-to videos that tell you how to create an automated table of contents in Word, but here are the basics, and… Continue reading What’s Inside? Tables of Contents

When you document computer systems, software, or corporate processes, it’s easy for the documentation to get out of date. A new software release comes out, new processes are instituted, a new server comes on board in the data center. How do you know when it is time to update a document? There are a couple… Continue reading Past Its Sell-By Date

Who is your audience? It’s the first question you should ask about virtually any document that you write or website you create or presentation you prepare. Knowing the audience: Sets the tone of the presentation—chatty or formal. Is your audience your team or your legal department? Determines the level of technical detail—Is your audience the… Continue reading Audience participation

We’ve all been there. We look in the shared directory and find a group of similarly titled documents. Proposal May 1, 2014, v1 CB Proposal revised final Proposal—final approved—JB Comments Proposal-2-3  How in the world can you tell what is the latest version, the approved version, the one you should send out, the one you… Continue reading Is this the final final version?

Technical writing is only good if it conveys information in a clear and unambiguous way. So it’s essential to have reviewers tell you if whether you hit the mark or not. It can be a bit tough to hear or read that feedback though. You did what seemed like a great job, and now you… Continue reading Handling Criticism