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....
View ArticleRelease Notes: 7 Steps to Better Enhancements
Want to improve the quality of the enhancements in your Release Notes? Here are seven ways. Enhancement Identifier Provide the reference number for the enhancement, such as Salesforce 12345. Business...
View ArticleRelease Notes Writing Checklist: 7 Don’ts and 13 Do’s
If your technical writing job involves writing release notes, create checklists for writing, reviewing, and production. Use the following checklist to review release notes. Avoid the following mistakes...
View ArticleSoftware 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...
View ArticleConfiguration 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...
View ArticleRelease Notes: how to test technical accuracy
Q: 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?...
View ArticleIBM 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....
View ArticleRelease 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...
View ArticleSample 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...
View ArticleError Message Writing Guidelines
Error messages should: · Be helpful: explain how to fix the problem, avoid repeating it again, and saving any data you’ve entered, if possible · Be specific: focus on one issue. Avoid general...
View ArticleWhat 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....
View ArticleOracle 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...
View ArticleSample 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...
View ArticleUser 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...
View ArticleClik here to view.
The Definitive Guide to Writing Error Messages
These guidelines will help you write error messages that are easy to update and useful for customers. Error messages are the first line of customer support. Poorly written error messages increase...
View ArticleClik here to view.
Error Messages: Mistakes to Avoid
Try to avoid the following: Anthropomorphize. Don’t suggest the software has feelings or thoughts, for example, the PC died. Instead, say, it stopped responding or is not available. Blame. Maybe the...
View ArticleClik here to view.
[How to] Write a Customization Guide
The first question is: who are you writing this customisation guide for? As a technical writer, the skill to developing a useful guide is to keep the reader in mind. Who will be reading this...
View ArticleHow to Write Error Messages
How to Write Error Messages Error Message Template – Download Now! Here’s a suggested approach to writing error messages: · Create a spreadsheet. · Give each error a number so you can track them. · Add...
View ArticleError Messages: Do’s and Don’ts
Do’s and Don’ts when writing error messages: Don’t · Avoid the word “bad”. Use more descriptive terms to tell the user what is wrong. For example, avoid messages such as “Bad size”. Instead, tell the...
View ArticleMicrosoft Error Message Guidelines
When you write messages, follow these guidelines: · Avoid vague wording. Give specific names and locations of the objects involved. · Avoid “please.” It can be interpreted to mean that a required...
View Article