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: Web Authoring Tool From:"Brierley, Sean" <Brierley -at- QUODATA -dot- COM> Date:Wed, 17 Feb 1999 09:25:09 -0500
Hallo:
A good thought for the group to consider, and maybe the original poster,
too.
>>>From: Atkinson, Phil [mailto:Phil -dot- Atkinson -at- braid -dot- co -dot- uk]
>>>Sent: Wednesday, February 17, 1999 9:14 AM
>>>To: 'Brierley, Sean'; TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>>>Subject: RE: Web Authoring Tool
>>>
>>>
>>>My opinion:
>>>
>>>You shouldn't confuse an on-line manual with on-line help.
>>>HTML help is
>>>on-line help in HTML format - it isn't an on-line manual.
>>>The very term
>>>manual suggests hard-copy material and is by its very
>>>definition a different
>>>style and format to on-line help. If you wish to provide
>>>your users with a
>>>manual,
I don't confuse an on-line manual with on-line help. However, the original
post is not clear as to what the deliverable will be. Certainly, on-line
help provides documentation in an on-line form. In the case of HTML help, an
index and TOC are provided to navigate a body of text that are viewable by a
browser. The HTML help is very structured and navigable. Certainly, it is
not printable.
Is HTML help an on-line manual? I would argue it can be, if you want. My
preference is PDF. I do not provide on-line HTML help or WinHelp as a
"manual" of any kind, but it seems the original poster might. I am not sure
what the original poster's goal is nor do I know the expectations of their
audience; perhaps I should have asked? Certainly, if I want to put a book
on-line in HTML format rapidly, HTML help tools are a quick and efficient
way to get the job done. So, is on-line HTML help a manual? Group? Anyone?