TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
-----Original Message-----
From: On Behalf Of Julie Stickler
Sent: Thursday, September 13, 2012 2:12 PM
To: TechWhirl (techwr-l -at- lists -dot- techwr-l -dot- com)
Subject: Re: How do you ensure document quality?
On Thu, Sep 13, 2012 at 3:52 PM, Steve Janoff (non-Celgene)
<sjanoff -at- celgene -dot- com> wrote
> Might be helpful to define what you mean by "document quality."
I'm rather fond of how IBM answers that question in their book
Developing Quality Technical Information. Their definition
incorporates a lot different things that I'd been told to focus on
over the course of a decade long career. They break quality down into
three characteristics:
Easy to Use (Task oriented, Accurate, Complete)
Easy to Understand (Clear, Concrete, Style)
Easy to Find (Organization, Retrievability, Visual effectiveness)
For more details, you can check out the "Look Inside" preview of the
Table of Contents over on Amazon.
*********************************************************
THIS ELECTRONIC MAIL MESSAGE AND ANY ATTACHMENT IS
CONFIDENTIAL AND MAY CONTAIN LEGALLY PRIVILEGED
INFORMATION INTENDED ONLY FOR THE USE OF THE INDIVIDUAL
OR INDIVIDUALS NAMED ABOVE.
If the reader is not the intended recipient, or the
employee or agent responsible to deliver it to the
intended recipient, you are hereby notified that any
dissemination, distribution or copying of this
communication is strictly prohibited. If you have
received this communication in error, please reply to the
sender to notify us of the error and delete the original
message. Thank You.
*********************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
