documentation metrics

Subject: documentation metrics
From: Sam TechWriter <samtechwriter -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 13 Jun 2007 10:35:43 -0700 (PDT)

Historically, documentation metrics at our company have been limited to accuracy. We'd like to expand the metrics to usability, as defined by customers when talking to technical support. (Eventually we'd like to collect usability metrics in more meaningful ways, but this is a good start.)

My documentation group is looking at designing "check the box" metrics for technical support to gather when talking to customers and updating or creating "bugs" in the company database. We're fairly certain that technical support will be amenable to tracking this data if we make the metrics easy to gather.

Have any of you done this kind of thing before? Care to evaluate the "check the box" metrics below?

[First branch: "Documentation should include this information" with an indicator of the "opinion-owner" - technical support and/or customer]

* Customer did not review the documentation
>>Does not know where the documention is located
>>Has had problems finding information before so didn't even try
>>...other? fill in the blank?

* Customer searched the documentation but could not find resolution

* Customer found information in the documentation but it was not helpful
>>fill in details....

* Additional comments by technical support

Thanks in advance,
"Sam TechWriter"

Get the free Yahoo! toolbar and rest assured with the added security of spyware protection.

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.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: "Saved sorts"
Next by Author: Indian jobs?
Previous by Thread: RE: Automatic editing?
Next by Thread: Remember "persist the data "?

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

Sponsored Ads