RE: doc'ing the docs

Subject: RE: doc'ing the docs
From: "Sean Brierley" <sbri -at- haestad -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 4 Dec 2002 17:16:50 -0500


Mine is a real world case.

Engineers used to working in a software environment called me to task
for not having help, when the case was that if they knew how to use the
help, they'd have been all set.

Thus, the help-on-help helped the engineers in question and had the
added bene of being a CYA.

Cheers,

Sean

-----------------------------------------
Sean Brierley
Software Documentation Specialist
Haestad Methods
http://www.haestad.com
203-805-0572 (voice)
203-597-1488 (fax)



-----Original Message-----
From: Gordon Meyer [mailto:gordonmeyer -at- mac -dot- com]
Sent: Wednesday, December 04, 2002 5:12 PM
To: TECHWR-L
Subject: Re: doc'ing the docs



Sure, we can all imagine situations where "help on help" might be
useful, but here's an actual example. (Product name obscured to avoid
accidentally embarrassing someone.) As they say, the proof is in the
pudding, and there's nothing here that either already hasn't been
discovered by the user (because they've navigated to this page) or
isn't completely obvious. For example, it contains the shocking
revelation that the the index is in alphabetical order and contains
links (which are blue and underlined) to associated topics.

Thanks for the hypothetical examples of where such doc is useful and
could have a significant impact, but I'm still hoping to find a
real-world case. Hope spring eternal.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. 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: RE: Frame Maker Book file-Query!
Next by Author: RE: Comparing Nations
Previous by Thread: RE: doc'ing the docs
Next by Thread: RE: doc'ing the docs


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


Sponsored Ads