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

How to write documents for SaaS web applications

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. Registration – explain how to set up the account, register an account, common setup issues, and troubleshooting, for example, if […]

How to Perform a ‘Post Mortem’ on Technical Documents

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 Quantitative data — such as, the difference between the project estimate and the hours worked. Qualitative data — such as, satisfaction, […]

Writing Guidelines For Release Notes Enhancements

What do you need to include in your enhancement release notes? 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 At a minimum, you need to cover the following: Description – identify the new enhancement. Avoid the words new, enhancement, […]

Release Notes: Sample Text for Writing Enhancements

An enhancement is a new feature, or an improvement to a current feature, included in the current release. To help the reader understand the enhancement, describe: Where the enhancement is located in the user interface. What parameters need to be configured. What is the default setting. Why you should use this enhancement, for example, a […]