RE: suggestions on how to "hide" UI-based topics in online Help TOC?

["Christine Kent" <c -dot- bkent -at- bigpond -dot- net -dot- au>]

Well Janice, I stand corrected.  I concede that after 20 years of
documenting software systems, I still have much to learn.  Thankyou.

Christine

> -----Original Message-----
> From: techwr-l-bounces+c -dot- bkent=bigpond -dot- net -dot- au -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+c -dot- bkent=bigpond -dot- net -dot- au -at- lists -dot- techwr-l -dot- com] On
> Behalf Of Janice Gelb
> Sent: Tuesday, 25 March 2008 11:10 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Re: suggestions on how to "hide" UI-based topics in online
> Help TOC?
> 
> Christine Kent wrote:
> > If I have understood, this all sounds pretty standard to me.
> >
> > Both types of documentation are required.
> >
> > We used to use terms like User Guide for process based documentation,
> and
> > Help for function based documentation.  Software development projects
> often
> > do both kinds of documentation, as they serve different needs.  Some
> people
> > need to work out how to do the job so they want the process based
> > documentation, and some people just need to work out what to do with
> a
> > particularly nasty field, so they need the function based
> documentation.
> >
> 
> "Required" is rather a loaded word. The answer to
> the issue of whether interface-based information is
> necessary for product documentation usually depends
> on the product. If your audience is users of the
> interface and not interface developers, then they
> could easily need to know the interface only in
> relation to tasks that they need to do, and generally
> rarely examine the interface independent of trying
> to accomplish some specific goal.
> 
> -- Janice
> 
> ***********************************************************
> Janice Gelb          | The only connection Sun has with
> janice -dot- gelb -at- sun -dot- com  | this message is the return address
> 
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> 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 c -dot- bkent -at- bigpond -dot- net -dot- au -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/c.bkent%40bigpond.net.au
> 
> 
> 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.
> 
> No virus found in this incoming message.
> Checked by AVG.
> Version: 7.5.519 / Virus Database: 269.22.0/1341 - Release Date:
> 24/03/2008 3:03 PM
> 

No virus found in this outgoing message.
Checked by AVG. 
Version: 7.5.519 / Virus Database: 269.22.0/1341 - Release Date: 24/03/2008
3:03 PM
 

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

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.