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.
That use case is describing a solutions database rather than a [conventional] help system.
Adding user comments to the help implies that new information is being added, and that it should be shared via one server to many clients. Help is usually client side.
The information in help systems is by nature pretty static (though the presentation can be dynamic).
Again, what's the environment? What's the audience? What's the budget?
2003-05-21 14:04:16, Brian Das <brian_das -at- hotmail -dot- com> wrote:
>John Cornellier wrote: "In MS's "HTML" Help and Sun's JavaHelp you can also
>add a link to a (hard coded) file name (e.g. called mynotes.html) the
>contents of which the user can edit, and it'll appear in the help without
>the need for recompiling."
>This solution (and a recent solution that suggested using a .txt file) puts
>an onus on the user to edit and save (and not move or rename) a file --
>that's a big margin for error, and a lot of clickthrough. And the help
>system wouldn't be able to tell the user which topics have saved comments
>and which don't -- the user would have to click every link in every topic to
>Can anyone think of a solution that doesn't have this risk? The only one I
>can think of is to deploy the help on a server, and install a local database
>or spreadsheet on the client machine.
>Here's a simple use case: The user clicks a "comment" link in a help topic
>that opens an ASP page (or whatever). The ASP page presents a textbox. The
>user types the comments and clicks save. The ASP page saves the comment in a
>local database. The next time the user opens the page, it detects if there's
>a comment and lets the user know (with an icon, or something).
>And who's got the time and coin to build something like that?!? Go with
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.