Quantcast
Channel: Klariti Technical Writing »» How To
Browsing latest articles
Browse All 20 View Live

Error 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 statements....

View Article



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....

View Article

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...

View Article

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...

View Article

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...

View Article


Image may be NSFW.
Clik 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 Article

Image may be NSFW.
Clik 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 Article

How 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 Article


Error 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 Article


Microsoft 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
Browsing latest articles
Browse All 20 View Live




Latest Images