Re: Multiple Platforms documentation

Subject: Re: Multiple Platforms documentation
From: Melonie Holliman <mrh -at- ABMDATA -dot- COM>
Date: Mon, 17 Jun 1996 08:59:38 +0000


Pam Shannon writes:

>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,


>Does anyone out there have a solution?

My company has the same problem. We have not released the
product so I cannot tell you if the customers liked it.
We are a small company producing a RDBMS. This is the way
we decided to handle it.

We are going with a modular format. Our documentation includes
small paperback modules (booklets of 32-90 pgs), rather than chapters,
boxed together. This gives us the flexibility to have modules covering
general subject matter and those platform specific without having to
make completely different manuals. Also, some of our customers will
want more of certain modules; we can give them that without the cost
of unwanted documentation.

By the way, this also seems to be a more cost effective solution than
a big perfect bound manual. We also hope it will be easier to upgrade
(not having to reprint those which do not change).

Hope this helps.


Melonie R. Holliman | ABM Data Systems, Inc.
Technical Writer | 9020 Cap of Tx Hwy, Ste 540
mrh -at- abmdata -dot- com | Austin, TX 78759
The views and opinions expressed here are strictly my own and
do not reflect ABM policy or opinions!!
----------------Gig'm Ags! Class of '90---------------------

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

Previous by Author: Screen Captures, Paint Shop Pro
Next by Author: Re: Readability---initial caps?
Previous by Thread: Risk Communication
Next by Thread: Re: Multiple Platforms documentation

What this post helpful? Share it with friends and colleagues:

Sponsored Ads

Sponsored Ads