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.
Re: Why not do it ourselves? (Was: using 3rd-party books)
Subject:Re: Why not do it ourselves? (Was: using 3rd-party books) From:Peter <pnewman1 -at- home -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 19 Sep 2001 08:37:24 -0400
"Carey Jennifer (Cry)" wrote:
> It's true that popular software products provide a manual with the product.
> Some of these manuals are quite good and some are rather difficult to use.
> With many popular products, the good manuals are often supplemented by 3rd
> party manuals that are available on the market, and the bad manuals are
> often practically redone. With the recent bombardment of
> "fill-in-the-blank- for dummies" books (though most dummies I know don't
> bother to read books about their area of interest!) it's made me wonder why
> we don't write manuals in such a way that these books don't need to be
> written?
>
> For example, what would happen if we wrote both a basics (for new users)
> manual, an intermediate-advanced use manual and included those with our
> product in the first place? Third-party books are often infused with
> "light-hearted" and quippy personality, including silliness and fun. What
> would happen if we did this in ours?
The third party books are written because someone believes that the
manuals don't fill all needs. Usually, they are right. Many consumer
software publishers regard documentation as a necessary evil (overhead,
rather than profit center.)
In order to be truly objective, the bugs, (er, features,) would have to
be documented together with workarounds. Marketing gets upset when this
happens.
As for writing in a light and quippy style, there are endless threads
here on that issue.
--
Peter
Mailto:peternew -at- optonline -dot- net
Adapting old programs to fit new machines
usually means adapting new machines to
behave like old ones.
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.