Re: Documentation Quality and Standardization

Subject: Re: Documentation Quality and Standardization
From: John Posada <jposada99 -at- gmail -dot- com>
To: quills -at- airmail -dot- net
Date: Wed, 22 Apr 2009 15:33:50 -0400

> I write gude. So that is quality. Or is it? Is it the number of spelling
> errors? Is it grammar? Is it ease of use? Is it total inclusion of all
> information?

Reults. The documentation has a purpose; Installation docs--successful
install. Configuration doc--sucessful configureation.

A defect is when it doesn't do what it is supposed to. You can have
1,000 typos, but if 100% of the people get the instuctions right, the
quality of the doc is better than if 15% of the people get the results
of the documentaiton incorrect.

Base it on what it is trying to accomplish.


--
John Posada
Senior Technical Writer

NYMetro STC President
"Register for our next event on wikis by going to
http://www.stcnymetro.org/events/notices/apr232009.htm

Looking for the next gig.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Previous by Author: Re: Documentation Quality and Standardization
Next by Author: Re: Documentation Quality and Standardization
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