Re: Documentation Quality and Standardization

Subject: Re: Documentation Quality and Standardization
From: quills -at- airmail -dot- net
To: punit shrivastava <punitshrivastava -at- gmail -dot- com>
Date: Thu, 23 Apr 2009 01:30:29 -0500

Standardization of the document is part of quality only so far as it
agrees with your standarization requirements. If you have a style guide,
you should follow it. That could be part of your quality metrics.
However, it doesn't mean that the document is worthwhile for your
end-users. It just says that you are following a standard look and feel,
using specific formatting, etc.

If you want, you can define your entire quality effort in that way.

Scott

punit shrivastava wrote:
> Hey Guys,
> Very helpful views. Thanks for that.
> But just one doubt which I would like to get cleared.
>
> When we talk of quality standard of document, is it just about usability
> factor for end user?
>
> What about the formatting and look and feel factor of documentation?
> Shouldn't such factors also be considered while defining Quality of a
> document?
>
> thanks
> Punit
>
> On Thu, Apr 23, 2009 at 3:12 AM, Chinell, David F (GE EntSol, Security) <
> David -dot- Chinell -at- ge -dot- com> wrote:
>
>
>> I like to think of delivering value to the reader.
>>
>> One expression of value is this:
>>
>> Value = Quality / Cost
>>
>> However, due to the difficulty of defining meaningful "quality"
>> measures, I started thinking of utility. Like this:
>>
>> Value = Utility / Cost
>>
>> Utility depends on the reader's purpose -- one can only say whether or
>> not something is useful in the context of a purpose.
>>
>> So in the end I come back to agreeing with John, that you have to
>> determine whether or not the reader achieves the result determined by
>> the purpose.
>>
>> Bear
>>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com

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! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Documentation Quality and Standardization: From: punit shrivastava
Re: Documentation Quality and Standardization: From: John Posada
Re: Documentation Quality and Standardization: From: quills
Re: Documentation Quality and Standardization: From: John Posada
RE: Documentation Quality and Standardization: From: Chinell, David F (GE EntSol, Security)
Re: Documentation Quality and Standardization: From: punit shrivastava

Previous by Author: Re: Documentation Quality and Standardization
Next by Author: Re: telecommuting - advice needed
Previous by Thread: Re: Documentation Quality and Standardization
Next by Thread: Re: Documentation Quality and Standardization


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

Sponsored Ads


Sponsored Ads