RE: Software Manuals

["Fred Ridder" <docudoc -at- hotmail -dot- com>]

"Software manual" is *much* too broad a category. It's
like asking what is the contents of a novel--it depends on
whether it's a mystery, a fantasy, a romance, a spy story,
science fiction, a roman a clef, or even a graphic novel.

The requirements for end-user software applications are
very different from those for an API, or a high-level
programming language, or a debugging tool, or some
sort of system admin tool, or a device driver. For end-user
apps, the requirements are very different for a graphics
app vs. a spreadsheet vs. a video editing tool. And within
many of the other categories there can easily be the need
for several different documentation deliverables for
different user roles (e.g. system administrator vs.
developer or integrator vs. end user).

-Fred Ridder


>From: "Johnson, Joyce" <JJohnson -at- abc-sg -dot- com>
>To: <techwr-l -at- lists -dot- techwr-l -dot- com>
>Subject: Software Manuals
>Date: Mon, 16 Jul 2007 17:10:56 -0500
>
>Hi All -
>
>What should be included in a software manual?
>
>This may seem like a simple question, but a colleague of mine has a very
>different opinion than mine on exactly what the contents of a software
>manual should include, so I'm asking the experts.
>
>How do you feel about screen captures in a software manual? Are they
>essential or can you do without them?
>
>Do you think online help can replace a software manual?
>
>Thanks for your help!
>Joyce
>
>
>
>Joyce Johnson
>Lead Technical Writer
>AmerisourceBergen Solutions Group
>875 Woodlands Parkway
>Vernon Hills, IL  60061
>847/808-5875
>

_________________________________________________________________
http://imagine-windowslive.com/hotmail/?locale=en-us&ocid=TXT_TAGHM_migration_HM_mini_pcmag_0507

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

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! 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.