Where there is a simple answer in the tutorial/reference manual, a link
from the faq is a good idea. For some questions, a simple answer is
required for the faq, but one might not be easily found in the manual. In
these cases, a link to a whole chapter of the manual might just encourage
more questions to the list.
ADK
--------------------------------------------
There is no magic.
"Noel J.
Bergman" To: "James Users List"
<[EMAIL PROTECTED]>
<noel@devtech. cc:
com> Subject: RE: Documentation
23/12/2002
06:58
Please respond
to "James
Users List"
> i have downloaded the latest release candidate and have 'reviewed' the
> documentation (www and xdocs) - a tremendous improvement over the earlier
> version, but no surprises there (you guys have been busy!!)
Peter Goldstein deserves 90%+ of the credit for the improved documentation.
He has worked his tail off on it on a daily basis. Documentation is one of
those thankless jobs for programmers, and I think that Peter deserves kudos
for his efforts.
With respect to continued development of the documentation, I think that we
should look at the questions and problems that users bring up online, and
use the FAQ as a sort of index. Rather than answer most questions in-line,
I'd create more detailed tutorial pages, and refer users from the FAQ to
the
more detailed tutorials.
That's my thought. Others may think differently. And since we have some
folks here with years of experience writing end user documentation, we
should try to benefit from their experience.
--- Noel
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]
>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]
>
-----------------------------------------------------------------------------------------------
Have you seen our website?.... http://www.vodafone.co.nz
CAUTION: This correspondence is confidential and intended for the named recipient(s)
only.
If you are not the named recipient and receive this correspondence in error, you must
not copy,
distribute or take any action in reliance on it and you should delete it from your
system and
notify the sender immediately. Thank you.
Unless otherwise stated, any views or opinions expressed are solely those of the
author and do
not represent those of Vodafone New Zealand Limited.
Vodafone New Zealand Limited
21 Pitt Street, Private Bag 92161, Auckland, 1020, New Zealand
Telephone + 64 9 357 5100
Facsimile + 64 9 377 0962
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
