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:Window vs. embedded help From:Joe <jsokohl -at- mac -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 12 Apr 2002 08:14:55 -0400
Hi all,
the following post appeared on another list (chiweb). I'm reposting it
here to elicit some aid from y'all. Feel free to respond to me directly,
and I'll summarize at the end of next week.
Here's the post:
<begin message>
In Short:
I am interested to know if anyone has
thoughts/data/experience/testing/etc. with in-line help documentation
vs. help documentation in a separate 'Help' window.
The Scenario:
I am working on a web-based application that is composed of various
sections. There are sections that will be used on a daily bases by users
and then there are administrative pages that are used to configure the
system that will not be used with much frequency. These administrative
pages are inherently more complicated and the changes made within these
sections affect the entire system.
Based upon frequency of use, I would guestimate that the daily pages
might be better off with a link to help documentation found in a
'window' to keep the pages free from a lit of noise while the
administrative tasks that are not used that often would lend themselves
to having documentation included on the page. I have looked at the
administrative pages for the Search tool in Atomz.com where all page
documentation is located on the page and personally found it quite
useful.
I am interested to know how other people have dealt with the same
situation and what they have discovered.
</end message>
joe
Joe Sokohl
Sokohl & Associates
----------------------------
Helping create digital solutions for real people
Technical writing, information architecture, and usability consulting
----------------------------
www.sokohl.com
www.cafepress.com/hcistuff (for fun)
+1-804-355-7227
+1-804-873-6964 (mobile)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
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.
