[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Fw: How do you ensure document quality?

Subject: Fw: How do you ensure document quality?
From: "WongWord -at- gmail -dot- com" <wongword -at- gmail -dot- com>
To: "'TechWR-L'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 14 Sep 2012 23:35:42 +1000



This is an excellent book. It's such a handy ready made manual with lists
and examples for everything.

I would add though that satisfaction is a really important quality too. It
is an element in some usability lists and at least one ISO standard. I would
add it as a fourth element to IBM's 3 that Julie mentions

Irene Wong

--------------------------------------------------
From: "Julie Stickler" <jstickler -at- gmail -dot- com>
Sent: Friday, September 14, 2012 7:11 AM
To: <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.


http://www.amazon.com/Developing-Quality-Technical-Information-Handbook/dp/0131477498

--
Julie Stickler
http://heratech.wordpress.com/
Blogging about Agile and technical writing

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as wongword -at- gmail -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and
info.

Looking for articles on Technical Communications? Head over to our online
magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public
email archives @ http://techwr-l.com/archives





--
Julie Stickler
http://heratech.wordpress.com/
Blogging about Agile and technical writing


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives

Previous by Author: RE: Cover Stories for Job-Hunting Absences
Next by Author: RE: Frame 7 into ATCS/Frame 11
Previous by Thread: Re: How do you ensure document quality?
Next by Thread: Re: How do you ensure document quality?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

What this post helpful? Share it with friends and colleagues:

Sponsored Ads