TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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-