New Technical Writer: Use The Persona To Create The Most Useful Section Of Your User Document

Posted by admin, October 22nd, 2009

OVERVIEW
A good User Document includes sections on how to set up, use, and care for the product. However, to create a great User Document , the technical writer should use the Persona, generated in the analysis of the User/Reader, to create the topics for the most useful section of the User Document. This […]

Great Technical Writing: Banish These Two Attitudes

Posted by admin, June 30th, 2009

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

Great Technical Writing: The User-Product Life Cycle - A Documentation Tool

Posted by admin, June 4th, 2009

The User-Product Life Cycle (U-PLC) is a powerful tool for the User Document writer. Use the U-PLC to generate the high-level topics for your User Document.
THE USER-PRODUCT LIFE CYCLE (U-PLC)
Usually, when we think of a Product Life Cycle, we think in terms of the development and production of the Product itself. When writing User Documentation, […]