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.
Re: Compare and Contrast Doc Group Performance -- What's aWorld-ClassDoc Group Look Like?
Subject:Re: Compare and Contrast Doc Group Performance -- What's aWorld-ClassDoc Group Look Like? From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 12 Mar 2008 14:43:02 -0700
I think it's important to keep in mind the source of the
request: management. These are the same non-writers
you usually have to pull teeth out of for an Acrobat or
FrameMaker upgrade, and their eyes will glaze over if
you even try to address subjective quality aspects such
as document usability. You can give them some of the
measurable document defect issues you listed, but what
they are really interested in hearing is that you can sit
down with a product owner and lay out a plan for docs
to accompany a product that will cover all the topics,
manage resources to complete documents that conform
to the plan and are completed within the schedule
constraints necessary to never be the hold-up in
product release and delivery, and that you can provide
accurate forecasts of the resources (i.e., money)
needed to consistently meet these goals. The only
way the subjective quality issues will get their attention
is if you can produce sworn affidavits from big money
customers that they chose to purchase your company's
products because they were impressed with how good
the documents were.
In the eyes of your corporate management and
stockholders, "world class" means "more profitable."
Gene Kim-Eng
"Fred Ridder" <docudoc -at- hotmail -dot- com> wrote in message
> In the case of information products, quality is a largely subjective
> assessment. Yes, there are clear-cut defects that can be identified
> and tracked--things like wrong information, missing/omitted
> information,
> typos, etc. But many of the real quality differentiators are things
> like
> ease of use (e.g. organization of information, navigation affordances,
> index), understandable and unambiguous expression of the information
> (e.g. clear writing, standardized terminology), and suitability for
> the
> reader's need (e.g. audience analysis, task analysis, information
> design).
> Each of these factors is a spectrum, requiring a judgement call as to
> the quality level. These important quality factors cannot be reduced
> to the kind of go/no-go (acceptable/defective) decision that makes
> metrics easy.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-