Error Message Writing Guidelines (and Word Template)

In this technical writing tutorial, we look at how to write better error messages. Error Messages Guide Template (MS Word) Use this Error Message Guide template (14 pages MS Word) to show users how to resolve error messages that may appear in your application. This template also comes in the Technical Writing Template Pack (233 pages MS Word). Scroll […]

Sample Website Installation Plan

The following guidelines explain how to install a website application. Getting Started It is recommended that you install and verify the software in your test environment prior to deploying it to your production environment. Warning – When specifying an existing database as the installation target, this install process will replace that existing database. Be sure […]

Release Notes: How to Validate Technical Accuracy

How can you validate the technical accuracy of your release notes? Follow these guidelines by creating a checklist and reviewing each item on the list. Download: Release Notes template package with 2 pre-formatted templates in MS Word. Download Now for $7.99- Buy Here! Learn more about these Release Notes Templates Files affected Have you entered the […]

IBM Error Message Guidelines

The following is an example of how IBM writes error messages. Notice the words and phrasing as well as how the alert categories are explained. Error Message There is no value specified for the User ID. Explanation You must specify a value for the user ID. Alert Category Similar events are grouped in categories. The […]

Release Notes: How to Test Technical Accuracy of Bugs and Enhancements

What do you after you’ve written your release notes? Test it. Download: Release Notes template package with 2 pre-formatted templates in MS Word. Download Now for $7.99- Buy Here! Learn more about these Release Notes Templates Here are four ways to check if the bugs, issues and enhancements are written correctly: 1. Can you reproduce the […]

Configuration Guides: How To Document Parameters

If you want your customers to keep using your products, make sure every parameter settings is correctly documented. So, how can you write glittering configuration guides that sparkle and amaze when customers print out the PDF? Here’s how, grasshopper. Make sure to capture the following when documenting every parameters in your technical documents. No excuses, […]

Software Testing: how to keep Agile projects on track

Is Agile software development good for a tester’s mental health? Depends, doesn’t it? So, how can we keep software testing projects on track when the Developers are using Agile to create sprints? What do we need to ask our developers? Ask Dev to confirm THEIR understanding of UAT It’s not enough to ask, ‘do you […]

Release Notes Checklist for Junior Technical Writers

If your technical writing job involves writing release notes, create checklists for writing, reviewing, and production. Download: Release Notes template package with 2 pre-formatted templates in MS Word. Download Now for $7.99- Buy Here! Learn more about these Release Notes Templates Use the following checklist to review release notes. Avoid the following mistakes when writing release […]

Release Notes: How to Write Enhancements

Want to improve the quality of the enhancements in your Release Notes? Here are seven ways. Download: Release Notes template package with 2 pre-formatted templates in MS Word. Download Now for $7.99- Buy Here! Learn more about these Release Notes Templates Enhancement Identifier Provide the reference number for the enhancement, such as Salesforce 12345. Business value […]

Context Sensitive Help: 13 Ways to Test and Improve

After writing the Content Sensitive Help, create a test plan to check that the Help works correctly. Before you start testing the Content Sensitive Help: Clear the cache. Open Excel to log errors. Don’t test your own work. How to Test Content Sensitive Help Use this checklist to test the Content Sensitive Help: F1 — […]