RE: Creating a Documentation Kit (Long Response)

Subject: RE: Creating a Documentation Kit (Long Response)
From: John Posada <jposada01 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 18 Oct 2001 19:28:38 -0700 (PDT)


--- Steve Hudson <steve -at- wright -dot- com -dot- au> wrote:
> I disagree slightly with you there John. Providing the help as
> hidden text is
>
> 1) extra baggage to be opened each time with the template.
>
> 2) extra baggage in new documents based on the template.
>
> I prefer the hyperlink from the Help > About this template to the
> User Guide.

You mean place the user Guide online? This goes on the assumption
that you are online when you need to access the guide and that if the
guide is on the company intranet, that you can access it easily from
the otherside of the firewall. I can think of several instances in
recent past where both of these factors would have been an obstacle.

As far as baggage, not really. I've created several templayes
recently where I has a couple of pages of comment for each of 5
sections of the document. It didn't seem to be an issue.
Besides...when you "publish" the document, you could delete the comments.

=====
John Posada, Senior Technical Writer
mailto:john -at- tdandw -dot- com, 732-259-2874

__________________________________________________
Do You Yahoo!?
Make a great connection at Yahoo! Personals.
http://personals.yahoo.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

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


Follow-Ups:

References:
RE: Creating a Documentation Kit (Long Response): From: Steve Hudson

Previous by Author: RE: Creating a Documentation Kit (Long Response)
Next by Author: Re: SAS70 Audit?
Previous by Thread: RE: Creating a Documentation Kit (Long Response)
Next by Thread: RE: Creating a Documentation Kit (Long Response)


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

Sponsored Ads


Sponsored Ads