RE: UNIX and Windows documentation

Subject: RE: UNIX and Windows documentation
From: "Spreadbury, David C." <David -dot- Spreadbury -at- marconi -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 2 Apr 2002 15:01:28 -0500


Did this same process with a hardware document where the hardware was
supported on three different operating systems (Solaris, IBM, and Silicon
Graphics). Used the same features as mentioned below. Works like a charm.

-----Original Message-----
From: Jan Henning [mailto:henning -at- r-l -dot- de]
Sent: Tuesday, April 02, 2002 1:51 PM
To: TECHWR-L
Subject: Re: UNIX and Windows documentation



>Has anyone been tasked with creating one set of docs for software that is
>available for multiple UNIX AND Windows platforms?
>[...]
>Does anyone have any suggestions for making this combined set of
information
>manageable?

We have used conditional text in a similar situation: One set of source
files containing teh description for both Windows and Mac OS. Where there
were differences, we described both and marked the platform-specifgic
parts with an appropriate condition.

We then produced two sets of output files, one for each platform. In each
set, the non-applying parts were hidden. As John has already indicated,
this is very easy using FrameMaker and it Conditions feature.

Hope this helps
Jan Henning

--------------------------------------------------------------------
Jan Henning
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany

Phone: +49 700 0200 0700, Fax: +49 81 79 93 07 12
E-Mail: henning -at- r-l -dot- de, Web: www.r-l.de
Handelsregister: München HRB 99345

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com

Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr

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



Previous by Author: Mac Pagemaker to PC Acrobat?
Next by Author: RE: Time to perfom a procedure
Previous by Thread: Re: UNIX and Windows documentation
Next by Thread: RE: UNIX and Windows documentation


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


Sponsored Ads