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 […]
[Checklist] Document Reviews
November 30, 2014 By
Use this checklist to review business, medical, or technical documentation. It is recommended to review the document for start to finish for each item on this list, instead of reviewing all items as you go through the document. In other words, check that all images are correct throughout the document. Fix any errors. Then go […]
14 Screenshot Guidelines for Technical Documents
November 14, 2014 By
The purpose of screenshots is to compliment the text, not replace it. This means that your screenshots compliment what you’ve written and help orient the reader. They also help reduce anxiety in the reader as they can check if they are on the right window. What to capture Identify where the user needs to perform […]