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.
We are facing what must be a common problem, and I wonder
whether anyone can suggest guidelines to help bring order out
We document a software product that runs on many platforms,
under several different operating systems. Functionality is
more or less the same, and some topics apply to all configurations.
But many do not.
The problem is how to structure a book, or chapter, that deals
with information which is different, in part, for one or more
platforms, or for one or more OSs. When the difference is just
between say, UNIX and Windows, we can handle that in text. Or,
if only SGI machines need a special command, we can explain it
as a special case. But when the numbers of possibilities get
big, (e.g. UNIX server, NT client, running on Intel, etc.) the
chapter becomes a maze of headings and exceptions that
just isn't effective.
There is the option of creating separate manuals, or separate
chapters, for each configuration. But this would involve a lot of
repetition -- ergo, maintenance headaches and room for error.
Does anyone out there have a solution?
pam -at- workgroup -dot- com
Workgroup Technology Corp.
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net