Release Notes: How to Validate Technical Accuracy

How can you validate the technical accuracy of your release notes? Follow these guidelines by creating a checklist and reviewing each item on the list. 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 Files affected Have you entered the […]

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

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

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

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

Release Notes: 13 Mistakes to Avoid When Writing Bugs and Enhancements

It’s easy to overlook the importance of release notes. But when customers want to know exactly what a specific parameter does, it’s the release notes that often turn too. Why? Remember, for very large document sets, it can hard to know which document contains the reference material you need to understand. For this reason, configuration managers, testers, […]

Using Google Plus to Write Technical Documents

Maeve asks on LinkedIn how we can use Google Wave to write technical documents. Well, the first consideration is that Google Wave is not designed as a tech authoring tool but for collaboration and ‘almost’ real-time information exchange. Saying that, it does offer many benefits if you need to plan/coordinate/review documents in a networked environment. Here are some ideas.