Re: Bad Documentation and Linux

Subject: Re: Bad Documentation and Linux
From: <neilson -at- windstream -dot- net>
To: Robert Lauriston <robert -at- lauriston -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 4 Dec 2009 17:15:05 -0600


> result never got read.
>
> "Why? 'Oh, it's too big,'" she recounted.

I was told my doc was no good because there were too many steps. Well, there *were* 16 steps! The product required the user to do every one of them. And indeed, I actually had overlooked an important in-between step. There were really 17.

The product was later revised to work with just one step.

For Linux (or any Unix) if you want to do command-line stuff, you have to wade through hairy documentation that tells you about hairy options you'd rather ignore. Personally, I like Unix command lines and am willing to read man pages. There *are* "Linux for the Terminally Drain Bamaged" books out there, I'm sure. Probably nobody reads them, too.


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

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
http://www.doctohelp.com/

Help & Manual 5: The all-in-one help authoring tool. True single- sourcing --
generate 8 different formats and as many different versions as you need
from just one project. Fast and intuitive. 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:
Re: Bad Documentation and Linux: From: Robert Lauriston

Previous by Author: RE: Chapter-page numbering, reasons for
Next by Author: RE: Redneck step of the day
Previous by Thread: Re: Bad Documentation and Linux
Next by Thread: Re: Bad Documentation and Linux


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

Sponsored Ads


Sponsored Ads