Tag Archives: Technical Documents

10 (More) Writing Guidelines for SaaS Applications

Your product has to compete with an increasing number of rivals. When you do land a prospective customer, make sure that the instructions are easy to follow, relevant, and unambiguous. Let’s look at two examples from Apple and Microsoft’s guidelines for web writing.

[Checklist] Document Reviews

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

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