Re: Documentation Quality Metrics

Subject: Re: Documentation Quality Metrics
From: Harald Klein <webmaster -at- textquest -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 20 Aug 2002 10:56:16 +0200

write now wrote:

The powers that be have determined that we will now provide quality metrics every month. I've read over several past threads and searched the Web, but didn't find exactly what I'm looking for. Everything posted seems to concentrate on the postive and negative aspects of metrics, where I'm looking for specific measurements.

If your group does quality metrics, what exactly do you measure? I'm trying to find some relatively significant measurements that won't take me a month to compile.

When I read this, readability measures and readability formulas came to my mind. Although these formulas also measure syntactical measures like sentence and/orword length, these formulas are quite useful. There are also some that are suitable for technical manuals like the Forcast formula. I am currently working on this topic and implemented the most popular one for English (and some other languages like French, German, Dutch, Spanish) in my text analysis program named TextQuest (, there is also a free test version for download).

The readabiliy analysis module also has a style function that one can use to get too long sentences and too long words displayed in a log file, so you can see what might have gone wrong.

Harald Klein
Social Science Consulting
Brückengasse 12
07407 Rudolstadt
Tel/Fax: +49 3672 488494

Want to support TECHWR-L? Get shirts, bags, hats, clocks,
and more from the TECHWR-L Store. All proceeds support TECHWR-L.

Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Documentation Quality Metrics: From: write now

Previous by Author: Re: Permission for linking to Web sites
Next by Author: Re: User's, Users, Users'
Previous by Thread: RE: Documentation Quality Metrics
Next by Thread: Re: Documentation Quality Metrics

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

Sponsored Ads