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: User and user guides From:Chris Morton <salt -dot- morton -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 19 Aug 2009 09:40:15 -0700
On Wed, Aug 19, 2009 at 9:06 AM, Edgar D' Souza <edgar -dot- b -dot- dsouza -at- gmail -dot- com>wrote:
> Sighh.. you just *have* to be an uneasy soul... and I think I know why.
> 1A. Lost. No, not the TV series.
> 1B. Hopeful. Hoping that the "user manual" actually describes how to
> perform a task, instead of moronically describing the fields in each
> 1C. If it's a manual you've written, then the answer is "doomed."
> 2. No, but you can write a guide for 99.5 users of a software. The .5
> is obviously a very uneasy soul, but that's an occupational hazard.
> 3. As much wood as a woodchuck could, if a woodchuck could and would
> chuck wood. Or, to paraphrase, as much technical as a user guide could
> be, if a user guide could and would be technical.
> Cheers (oh - you mean it isn't Friday yet? This was eerily akin to a
> Friday post.. but I haven't put out a flame for a long while, so
> please cut the disgruntled some slack.)
> Edgar D'Souza (http://edgar.b.dsouza.googlepages.com/)
> à_à my GIMP-Python "Tear-off" plugin at:
> On Wed, Aug 19, 2009 at 7:58 PM, Raj<uneasysoul -at- rediffmail -dot- com> wrote:
> > I have three queries:
> > What exactly is a user looking in a user manual?
> > Can a user guide be written for all users of a software?
> > How much technical can a user guide be?
> Free Software Documentation Project Web Cast: Covers developing Table of
> Contents, Context IDs, and Index, as well as Doc-To-Help
> 2009 tips, tricks, and best practices.
> 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!
> You are currently subscribed to TECHWR-L as salt -dot- morton -at- gmail -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> 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:
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-