Posted on

Using Weight Scoring Models for Technical Documents

perfectRecently, we looked at how to determine the quality of your technical documentation.

We suggested an approach where you:

  • Identify the scope
  • Identify quality criteria
  • Review a sample of documents
  • Create a baseline
  • Expand the scope

All this makes sense. However, we also need to look at how to define a fair scoring system.

Why?

Some writers have heavier workloads, others writer more complex materials, others may be clever enough to superficially complete their documentation, but not provide the depth of quality we need.

So, how do you address this?

One suggestion is to apply weights to different criteria. For example, let’s say one criterion is for the Executive Summary.

If it exists, you award one point. If not, zero.

However, this is still pretty crude and doesn’t give us much insight into quality.

An alternative approach is to give this criterion a fixed score, ranging from 1 -5, with five as the highest.

Or.

Sum the numbers for the document and award a percentage, say 1-5% for the quality of this piece. This is known as a weight scoring model.

Weight Scoring Models for Technical Documents

This approach allows you to determine the relative success of your product, in this case your documents, based on several criteria. To do this, you need to:

  1. Identify criteria for the selection process, ie what needs to be measured.
  2. Assign weight (i.e. percentages) to each criterion. The sum total must be 100%.
  3. Assign scores to each criterion for each type of deliverable, eg guide, online help etc.
  4. Multiply scores by weights and get the total weighted score.

However, what’s important is not which approach to take but to step back and see which is more appropriate for your quality initiative. You might also consider adopting an approach that’s simplest to roll out as you’ll have some data coming in and, if you start small, you can use this as a building block for larger rollouts.

Posted on 4 Comments

Are technical documents a waste of time?

“Don’t worry” she said. “No one reads this stuff anyway. Just get it done.” Sounds familiar? Continue reading Are technical documents a waste of time?

Posted on

Screenshot Tips #1 – Difference between Screen Shots and Screen Dumps

This is the first part in a series of lessons on how to create professional-looking screenshots. We’ll start with the basics and walk you through more advanced techniques, such as blending, merging and adding special effects to your screenshots. Continue reading Screenshot Tips #1 – Difference between Screen Shots and Screen Dumps

Posted on 1 Comment

Audience Analysis: Power Tools for Technical Writing

Documents fail for many reasons. One common mistake is to adopt a ‘one size fits all’ approach to your audience. This works only when generic material, usually of a non-technical nature.

When discussing Audience Analysis, David McMurray points out that, “for most technical writers, this is the most important consideration in planning, writing, and reviewing a document. You “adapt” your writing to meet the needs, interests, and background of the readers who will be reading your writing. Continue reading Audience Analysis: Power Tools for Technical Writing

Posted on

Why use Master Templates in Adobe FrameMaker?

Master templates let you control the format and positioning of every component in your FrameMaker documents. They are very powerful when they work correctly, but be careful. If you make a mistake, it will take many an hour to clean the documents. Continue reading Why use Master Templates in Adobe FrameMaker?