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

User Guide Checklist

This checklist summarizes the recommended structure and contents for User Guide documents. Introduction In this section, introduce the User Guide and cover the following areas: – Intended readers – identify the different user types, for example, system operators, home users, and experts. For each, identify the assumed level of experience and highlight the sections of […]

Writing Technical Documentation for Japanese Readers

Carsten Mende explains how loan words are used in China and Japan. These are English words that are commonly used in everyday Chinese, (i.e. loaned) but may not translate correctly if taken literally. He looks at how the ‘Chinese and Japanese languages incorporate English terms and how they are used’ and gives suggestions on what […]

User Guide vs User Manual – which is right?

Let’s say you’re setting up a new Tech Docs Dept. You need to create new guidelines, style guides and naming conventions. Should you call the user ‘documents’ User Guides or User Manuals? Which one is right? I was asked this question by a colleague in India who is setting up a Technical Publishing Dept in […]