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.
My immediate reaction - looking at the samples in the article, is that
the partial screen captures did not give close to enough info to help
the user get oriented to what they are looking at...
I would also think that the application matters. For example, I'm
working on something now where the dialog boxes are HUGE - both in size
and in content.
A person can get lost looking at one screen, let alone one part of the
screen. So I show the entire dialog box, and then I show the relevant
chunks that are being used in a specific procedure, but I always give a
link to a full pic for the reader to get oriented, and a verbal reminder
of WHERE this chunk is in the dialog box.
I hope it works... if you could see the box I'm talking about, you'd
understand why giving the same picture with different callouts each time
is NOT an option!
At the end of the day, as I follow this, and other threads - it's all
about meeting the needs of our audience. We need to be aware of the
research. But we need to research our audience... the documentation is
going to vary tremendously depending on their needs.
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-