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:Resources on Single Source Documentation From:Jodie Horowitz <Jodie -dot- Horowitz -at- HBOC -dot- COM> Date:Mon, 16 Jun 1997 10:56:38 +0200
Can anyone recommend good articles or books on single source documentation?
To give you an idea of the issues I'm dealing with, the application I am
documenting has a complex GUI. It has been decided that the Help file must
stand completely on its own for at least three reasons:
1. For easy conversion from Help to paper documentation
2. To minimize QA time
3. To avoid interference with the functioning of the application itself
This means that What's This? help is out. As a result, all screens and
dialog boxes must appear in the Help topics themselves. I'm not aware of a
good way of scaling graphics, so this will make the topics lengthy.
It also means that most Windows 4.0 functionality cannot be used. For
instance links via A keywords are very useful in a Help file. But when you
create a paper document from the help file, you must manually insert these
links as cross-references.
So in the end, it looks like we're basically back to Windows 3.1
functionality in our Windows '95/NT application. Unless I come up with
some other ideas fast.
Thanks in advance for any information you can give.
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html