User Guides and Help

Decades of experience in writing clear, user-friendly guides to software use, requirements, and the concepts behind the design.

Orienting the User

By the time users access Help, they are often frustrated and impatient. I direct them to the right features by orienting them in the screen space, both textually (“at the top right of your screen”) and where necessary, with screenshots that highlight the item:

Plain Language

Passive voice and stilted wording add obstacles for users simply trying to understand something. In most cases, I advocate for addressing users as one would any colleague, using industry technical terms that users can be expected to know, but explaining or highlighting any new ones that are software-specific:

Single Source Content

With XML-based content, you can re-use part or all of your Help content wherever it’s needed, in any format, from online HTML5 help to pop-up tips to printed manuals. It also makes translation and re-use of existing translations accurate and affordable.