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: Online Help Tool - Decision From:mearro -at- msn -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 10 May 2005 13:50:49 -0600
Joe:
There are quite a few help systems that provide context sensitive topics
as well as a table of contents that includes "book-like" or general info
topics. In fact, the majority of the help systems I've produced (and many
that I've used) have fit this description.
This level of detail requires more effort but gives users more flexibility
& better access to info. As a user, this is what I prefer. With more
robust help systems, there is also (understandably) more content that can
be reused between the online & print docs.
Mary
> I should clarify my comments:
>
> My definition of "online help" and "books" is perhaps idiosyncratic.
>
> To me, online help is highly topic-oriented help that is usually
> connected to and viewable directly within another application. Usually
> it is *only* viewable within that application. It usually features
> context-sensitive help. It is best accessed by an index or text search,
> in an unordered fashion, as the user works with the application.
>
> "Books" include printed books, books available online through PDF, and
> even books available online through HTML. Books are viewable by
> general-purpose tools such as Acrobat Reader or browsers. Books are not
> usually context-sensitive. They can be accessed by an index or by text
> search, but they are usually organized by a TOC, and the user often
> accesses them through the TOC.
>
> Some may maintain that the division between these two is blurry. My
> counter-argument is that when it is, you get unsatisfactory
> documentation.
>
> Joe
>
> -----Original Message-----
> From: bounce-techwr-l-216553 -at- lists -dot- techwr-l -dot- com
> [mailto:bounce-techwr-l-216553 -at- lists -dot- techwr-l -dot- com] On Behalf Of Suzette
> Leeming
> Sent: Tuesday, May 10, 2005 10:58 AM
> To: TECHWR-L
> Subject: Re: Online Help Tool - Decision
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.