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.
----------------------------------
Andrea Brundt asks
There's a new set of dialog boxes in my company's software. They replace
an old set of dialog boxes that did pretty much the same thing so I think I have to address this in the content.
----------------------------------
How many dialog boxes are there? You could simply document all of the new dialog boxes and put them in the main flow of your document, and keep the set topics for the old dialog boxes in a sepearte section. Then, including a "see also" or some other link from the new topics to its corresponding old topic. You could also have the topics for the old dialog boxes in a separate book in the TOC. You might also want to add a "New in this Version" topic that explains the difference with, perhaps, links to the appropriate topics for the old dialogs.
This would be easy to maintain for new versions as it would be a matter of simply removing the topics. It would also make it clear that there are new dialog boxes, but still provide easy access to information about the old dialog boxes.
Did that make sense? I can see the set up in my head, but because it's 7AM I'm having trouble translating those images. :-)
********************************************
"This is either madness or brilliant."
"It's remarkable how often those two traits coincide." -- Will Turner & Captain Jack Sparrow
Sean Hower - tech writer http://hokum.freehomepage.com
_____________________________________________________________
Create your own web site for FREE at http://www.freehomepage.com
NEED TO PUBLISH YOUR FRAMEMAKER CONTENT ONLINE?
?Mustang? (code name) is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to Web, intranets, and online Help.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! See a live demo that
will take your breath away: http://www.ehelp.com/techwr-l3
---
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.
