by Siobhan Walsh on June 30, 2015
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…
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.
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.
· Be precise: describe the issue…
The following guidelines explain how to install a website application.
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…
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:
Have you entered the files for its related product? For example, some…
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.
There is no value specified for the User ID.
You must specify…
Q: Grasshopper, what do you after you’ve written your release notes?
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…
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.
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?…
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 when writing release notes.
Want to improve the quality of the enhancements in your Release Notes? Here are seven ways.
Provide the reference number for the enhancement, such as Salesforce 12345.
Describe the benefit to the user if they use…
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:
Does your technical writing team have offices in Bangalore?
Many US software companies are moving technical writing projects to India, Romania, Singapore and Poland.
I often help these teams setup their tech writing dept and mentor junior writers who are…
SaaS and web-based applications are becoming more popular as they replace desktop or network installations. How you document them is mostly the same as documenting traditional but there are some difference. Let’s take a look.
After every major release, do a post mortem of your technical documentation and look at how you can improve team morale, writing process, document reviews, and the documentation product.
Post-mortems focus on two areas
← Previous Entries