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:Screenshots in hotspots: a good idea? From:Shreyas Doshi <shreyasd -at- relsys -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 8 Apr 2002 10:29:16 -0700
Hi everyone,
Our current user help has a lot of screenshots that are apparently
"critical" to user understanding.
Here is how the paper version of a topic in our current help looks like:
1. Do this. The "foo" dialog will appear.
[Screenshot of a typical "foo" box]
2. In the "foo" dialog, click "bar". The "foobar" dialog will appear.
[Screenshot of "foobar" dialog]
.
.
....you get the picture.
My job is to convert this manual to RoboHelp HTML, to be used in both MS
HTML help and WebHelp formats.
I have quickly realized that inclusion of screenshots as above might work
for the paper version, but does not make good reading for online help. Even
a procedure with 7 steps that has screenshots embedded between steps, as
above, runs to 3-4 screens and hence, entails considerable scrolling.
I was wondering if it might be a good idea to include screenshots in drop
down hotspots, a feature easily implementable using RoboHelp.
Thus, the new version would look something like:
1. Do this. The <hs>"foo" dialog</hs> will appear.
2. In the "foo" dialog, click "bar". The <hs>"foobar" dialog</hs> will
appear.
... where <hs> foo </hs> indicates a hotspot that will display the
appropriate screenshot when "foo" is clicked.
Thus, if the user wants to know what a particular dialog box should look
like, he/she will click on the hotspot. If he/she does not require
assistance about how the screenshot looks or the different options available
from a dialog box, it will remain hidden and thereby enhance readability.
Am I using the right approach to tackle this problem? Could I use another
approach or modify this approach? Did you ever have to create a "screenshot
intensive" user help for which you had to resort to a similar technique?
It can be assumed that removing screenshots altogether from the help is not
an option in my particular situation.
I would be glad if you could share your experiences about such a situation.
Kindly cc: me on your reply as I am on a digest.
Thank you,
Shreyas.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.