User Guide Checklist

Use this checklist to write your User Guide. The checklist will help reviewers determine if the specifications meet the quality criteria and comply with development methodology requirements. Download 4 MS Word User Guide Templates General Information System Overview – introduce the system at a high-level and its relationship to others, if necessary. References – list […]

Sample Microsoft Windows Error Messages

The following is an example of error messages for Microsoft Windows XP: When you try to install a program that uses the Windows Installer in Microsoft Windows XP, the program does not install, and you may receive an error message that is similar to one of the following error messages: The Windows Installer service could […]

Oracle Error Message Guidelines

The following is an example of how Oracle writes error messages. Notice the format of the error message: · ORA-00058 – error number for tracking · DB_BLOCK_SIZE must be string to mount this database (not string) – description of error message · Cause: what caused the error to occur · Potential reasons: note the use […]

What is an Error Message?

Q: What is an error message? An error message describes a problem that stop a user or system from completing a task. An error message must include enough information for the user to solve the problem. What types of error messages are there? In general, there are three types of error messages: · Confirmations · […]

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

You can validate the accuracy of your release note by creating a checklist and reviewing each item on the list until you know these by heart: Files affected Have you entered the files for its related product? For example, some DLLs may affect one version but not another. Make sure these are not entered by […]

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

Grasshopper, what do you after you’ve written your release notes? Test it. Here are four ways to check if the bugs, issues and enhancements are written correctly: 1. Can you reproduce the issue? Have you reproduced the issue on a local machine? Note that you’ll need the same version of the application that the bug […]

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, […]