“Is this documentation effective?” That can be an important question. Technical documentation that is poorly designed or poorly written, or that is not addressed to the right audience, can cause problems: dissatisfied customers, lost customers, wasted effort, and in the worst-case scenario, lawsuits or regulatory penalties. How can you determine if your documentation is adequate or where it can be improved? This presentation will show you how to evaluate the quality of your documentation and identify ways to improve it. I will discuss visual design, choosing content, working with standards, and more.
Continue reading →