Re: Documentation Quality and Standardization

Subject: Re: Documentation Quality and Standardization
From: Peter Neilson <neilson -at- windstream -dot- net>
To: punit shrivastava <punitshrivastava -at- gmail -dot- com>
Date: Wed, 22 Apr 2009 07:22:56 -0400

Fundamentally there are two approaches to quality:

1. Strive to meet the needs of the user, and check to ensure that you
are doing so. (The marketing team is already working on meeting the
desires of the buyer, which is not the same thing.)

2. Establish a set of standards (or borrow one from somewhere), and show
that your work meets or exceeds the standards.

It is possible to use approach 2 in the course of fulfilling approach 1.
It is also possible to use approach 2 without addressing approach 1 in
the least.

Why do you (or your organization) want to embark on this mission in the
first place? Your use of the word "standardization" suggests that your
goal may be to use approach 2.

punit shrivastava wrote:
> Hi All,
> I have got the opportunity to work towards achieving Documentation Quality
> and Standardization in my documentation team.
> Would someone guide me on the following:
> - What all we cover in deciding Quality of documentation?
> - How do we go ahead with it?
> Please note that our organisation already has all other measures (Style
> guides, QA Team and documentation guidelines) in place. The effort is to
> improve the output quality within the team.

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

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.

Please move off-topic discussions to the Chat list, at:

Documentation Quality and Standardization: From: punit shrivastava

Previous by Author: Re: anyone get the advertised FREE Information Mapping Desktop Guide ?
Next by Author: Re: Documentation Quality and Standardization
Previous by Thread: Documentation Quality and Standardization
Next by Thread: Re: Documentation Quality and Standardization

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

Sponsored Ads