Re: New Year's Documentation Quality Resolutions

Subject: Re: New Year's Documentation Quality Resolutions
From: "Wilcox, John (WWC, Contractor)" <wilcoxj -at- WDNI -dot- COM>
Date: Tue, 23 Dec 1997 09:49:00 -0800

----------
From: Snowden, Jim @Cimage

My goal is that our documentation would be called "Excellent" by all its
users. I've put down some ideas here of what that might mean and would
be glad for any feedback from other techwhirlers.

In order to achieve that goal, we need to ensure the documentation has
these general characteristics:
-------------------------------
I have only two suggestions to your otherwise admirable set of goals:

1. Add "concise." Get to the point in as few words as possible.

2. Move "useful" to the top of the list. Prime Directive: Consider the
audience, and write to _their_ needs.


Regards,

John Wilcox, Documentation Specialist
Timberlands Information Services, Application Delivery Group
Weyerhaeuser, WWC 2E2, Box 2999
Tacoma, WA 98477-2999 USA
253-924-7972 mailto:wilcoxj -at- wdni -dot- com
(I don't speak for Weyerhaeuser, and they return the favor.)

http://www.documentation.com/, or http://www.dejanews.com/



Previous by Author: CORRECTIONS RE: QUESTION: W-2 vs. 1099 Hourly Rates
Next by Author: Re: bibliography
Previous by Thread: New Year's Documentation Quality Resolutions
Next by Thread: Re: New Year's Documentation Quality Resolutions


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

Sponsored Ads


Sponsored Ads