TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Documentation for internal web site From:"Grant, Christopher" <CGrant -at- glhec -dot- org> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 17 Oct 2002 13:48:02 -0500
> I have a question: in creating documentation for a product
> website that is internal-only, what form of documentation would you
suggest?
> Job aid or manual? Reference-based or procedure-based manual?
It's pretty hard to answer that question without a some more upfront
information and research.
Why does a "product website" need documentation?
What is the product?
Who will be using it?
What is the product?
What do your clients _want_? (To illuminate the purpose of the
documentation, not to just give them what they want.)
What is the objective of the documentation?
What is the product?
Your questions about whether it should be a job aid or a manual,
reference-based or procedure-based are good one, but they are not arbitrary,
and can't be answered without more information. The form of your
documentation should be a deliberate choice, not an arbitrary decision. In
this writer's opinon, anyway. :)
Chris Grant
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
---
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.
