by Geoff Hart
Even the most skillful technical writers face the task of persuading Subject Matter Experts ("SMEs") to review our documentation for technical correctness; after all, they're the experts, not us. If pressed, even the most reluctant SMEs acknowledge the value of these reviews. For example, where the interface is in a state of flux, you may have documented something that's changed since you last saw it, or may simply have misinterpreted something that seemed perfectly clear to the person who developed it--and to nobody else. But reviews still take them away from their regular work. And when they're working overtime to meet a deadline--which is often the case in today's "hurry up" world--they find that additional work particularly intrusive and unwelcome. Being only human, rumors to the contrary notwithstanding, they'll seek ways to avoid the extra work or to focus on easier targets than technical checks--such as your writing style. Worse still, carefully reviewing the copious documentation generated by complex products requires concentration and dedication that reviewers may simply be unable to provide.
The bottom line? To obtain good reviews, you must make the process as painless as possible for reviewers. Here's how:
