OVERVIEW
Searches in User Documents (manuals, etc.) often fail because the Reader uses different words for a concept than the author uses. Since the Reader’s words do not appear in the document, the document search mechanism cannot find them, resulting in frustration. This article describes a User-friendly technique for improving searches, without having to change [...]
OVERVIEW
Most product documentation sounds like their product is the only thing in the User’s life. Such thinking results in User confusion and dissatisfaction. This article presents three real-life examples of this attitude, and what should be done to remedy these unfortunate situations. The article concludes with some techniques for the writer.
BACKGROUND
There are two important facts [...]
Overview
Incomplete User Documents disappoint your Readers. Two attitudes of many Technical Writers result in incomplete User Documents. These two attitudes are:
. “Everyone Knows That”, and
. “The User Can Figure It Out”
This article describes these attitudes and presents methods for overcoming them. The result is more effective User Documents and more satisfied Users.
1. “Everyone Knows That”
The [...]