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.
I'm writing online help for an application that will be used only within our
organization. This is the only help there is (no printed user manual or
anything). It's accessible from anywhere within the app by a link or
pressing F1, and will be displayed in a fixed-width browser window. The
width of the content frame in the Help is probably about 2/3 of the fixed
width of the application window.
What I'm not sure about is how best/whether to use screenshots. My first
thought was not to bother, because the help is going to be mostly accessed
from within the application. But now it's released and people are confused,
and the Project Manager wants to send a link directly to the Help to the
entire company, in lieu of training. So now we want screenshots because it
needs to stand alone too.
Most screens are a list of items (they collapse to one summary line, or
expand to show a lot more detail) that are almost full-screen width;
therefore, they're wider than the Help window. I don't want to cause
horizontal scrolling. Should I take screenshots of the entire width of an
item listing and shrink them to fit, making the text almost illegible but
giving a general idea of the layout? Or should I take screenshots of
sections that are less than full width but can be used full-size? The detail
view doesn't divide really cleanly but it's possible.
Any thoughts, suggestions, advice would be most appreciated....
Thanks,
Rosemary
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Buy RoboHelp Office in May and you'll save $100 with our mail-in rebate.
Or switch from Doc-to-Help or ForeHelp to RoboHelp Office for only $499.
Get the help authoring tool PC magazine recently awarded a perfect score!
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.