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 know we already have a similar thread going on placement of screen
shots, but my
question is a little different. I'm documenting a complex medical
imaging software
application and I need some advice as to how I should present and
organize the information.
Background: This software has several dialog boxes with several options
that require
in-depth explanation. For each dialog box, I have a heading that says
"About the XYZ
Dialog Box." There's a brief intro to the db and then a screen shot and
then an explanation
of each each field on the db. I then follow the db explanation with the
procedure topic
"Selecting XYZ." This procedure topic simply moves them through the
steps in order without much explanation of the options because I already
explained them in the db
explanation.
Problem: I'm not really happy with the way this works. It seems to
interrupt the flow of the
information, but the only alternative I can think of is to explain each
option within the procedure, but I could conceivably have Step 1 on one
page, and Step 2 one or
two pages later and the original screen shot could be three or four
pages away from the last step. How have you/would you handle this?
Thanks
Robin Allen
Twenty-Six Letters, Inc.
210-696-8721 voice
210-696-8724 fax
