[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Documenting the way software actually works WAS: Try selling the sizzle of what you do.

Subject: Re: Documenting the way software actually works WAS: Try selling the sizzle of what you do.
From: rs-on the road <rshade -at- fast -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 17 Feb 2003 10:19:31 -0500



As for the release notes, I've yet to meet an end-user who wasn't a
developer or manager who read them for supplementary information. I'm not
saying release notes are unnecessary, but if the end-user isn't reading
the manual (or even only scans it in an emergency) you can bet they're
not reading the release notes.

I read end user docs for every bit of hardware and software I use or am considering using. No, I don't sit down with a cup of coffee and read process description after process description, but I do search out conceptual information and read it as one of the steps of my learning the software. I refer to specific process descriptions when they apply to the task(s) I am performing.

I read release notes and read-me files - especially when I see differences between the application and what is described in the printed doc and/or online help.. I communicate with software companies if I find their documentation to be lacking in any way (inaccuracies, omissions, difficulties in locating information, etc.) - just as I do if a purchase a product that does not perform according to its manufacturer's claims. (I also send letters when I find the documentation to be well-done).


Russ Shade
Contract Technical Writing and Implementation Services

current gig: Pennsylvania Department of Health, NEDSS project









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

Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at http://www.ehelp.com/techwr-l


---
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.


Previous by Author: [Slightly OT] Software Distributors
Next by Author: Re: Saving Websites to CD
Previous by Thread: Re: Curious about what you do
Next by Thread: Re: Documenting the way software actually works WAS: Try selling the sizzle of what you do.

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads