Re: Quality assessment

Subject: Re: Quality assessment
From: Rick Lippincott <rjl6955 -at- gmail -dot- com>
To: Dan Goldstein <DGoldstein -at- nuot -dot- com>
Date: Thu, 12 Feb 2015 12:24:08 -0500

Erika:

I think your first instinct is a good one, check with your local STC
chapter and talk to people who are involved with the competitions. See
if you can get some of the checklists and criteria used for judging
docs.

Another approach, as suggested above, might be to talk to people
involved in doing QA on docs in industries similar to your own. If you
can't find that, I'd suggest following the methodology used in
aerospace documentation QA: it's very rigorous. I can provide some
additional information if you need it.

Finally, I assume also youâre going to have to come up with a method
of rating the docs to determine the quality. â75 errorsâ is one thing
in a 10 page doc, something entirely different in a 500-page doc. Iâve
had some experience with that, let me know if youâd like some
additional information.

Hope that helps,

--Rick


On 2/12/15, Dan Goldstein <DGoldstein -at- nuot -dot- com> wrote:
> If Those Who Sign Checks insist on this uncontrolled experiment, then see if
> you can find a consultant who's worked at a government agency that deals
> with your industry (whatever that might be). Failing that, maybe find a
> consultant who's made successful regulatory submissions in your industry.
> Regulations don't necessary lead to higher quality, but at least they imply
> a certain uniformity.
>
> -----Original Message-----
> From: Erika Yanovich
> Sent: Thursday, February 12, 2015 10:54 AM
> To: Dan Goldstein; TECHWR-L (techwr-l -at- lists -dot- techwr-l -dot- com)
> Subject: RE: Quality assessment
>
> No standards, a comparison with other companies in the industry should be
> enough.
>
> -----Original Message-----
> From: Dan Goldstein
> Sent: 12 February, 2015 16:56
> To: TECHWR-L (techwr-l -at- lists -dot- techwr-l -dot- com)
> Subject: RE: Quality assessment
>
> Is there a specific ISO or other standard against which the docs should be
> audited? An industry-specific standard can be helpful in this regard.
> Otherwise, a consultant is likely to bring their own "best practice" (ha!)
> criteria.
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy &
> Procedure Guides, eBooks, and more using Microsoft Word |
> http://bit.ly/doctohelp2015
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as rjl6955 -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy & Procedure Guides, eBooks, and more using Microsoft Word | http://bit.ly/doctohelp2015

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

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


Follow-Ups:

References:
Quality assessment: From: Erika Yanovich
RE: Quality assessment: From: Dan Goldstein
RE: Quality assessment: From: Erika Yanovich
RE: Quality assessment: From: Dan Goldstein

Previous by Author: Re: Note versus Tip
Next by Author: Re: Proofreading your own material
Previous by Thread: RE: Quality assessment
Next by Thread: Hottest trends in tech writing


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

Sponsored Ads


Sponsored Ads