Review Checklist for Technical Documents

Making a list, checking it twice… How do you review your technical documents? You just don’t eyeball them, right? Before you send your shiny new user guide into the wild, use the following checklist to review your technical documents: Title Is the title consistent across all documents? Note lower, mixed, and upper case combinations Product […]

How to Write Error Messages: Faster, Stronger, Better

Blame the cat, TV, or the neighbors if you want. The thing is: stuff happens. When it does, you need some way to fix it, pronto. Aren’t  I right? This is where error messages can save you bacon. No one thinks of writing an error message guide until it’s too late. So, I’m telling you […]

How to Write Release Notes: Faster, Stronger, Better

So, you want to write release notes but don’t know where to start? Well pull you a chair and let me give you the lowdown. Download – Release Notes template with sample text. Introduce the release notes with text such as the following: These release notes provide information about the documentation for <your product> <version […]