RE: Modular documentation

Subject: RE: Modular documentation
From: "Sarah Bouchier" <Sarah -dot- Bouchier -at- exony -dot- com>
To: "Sarah Bouchier" <Sarah -dot- Bouchier -at- exony -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Sep 2006 14:48:06 +0100

PS being able to be safely integrated using Perforce would be a bonus...

-----------------------------------------
Sarah Bouchier
Technical Author

exony


>-----Original Message-----
>From: techwr-l-bounces+sarah -dot- bouchier=exony -dot- com -at- lists -dot- techwr-l -dot- com
>[mailto:techwr-l-bounces+sarah -dot- bouchier=exony -dot- com -at- lists -dot- techwr-l -dot- com]
On
>Behalf Of Sarah Bouchier
>Sent: 20 September 2006 14:01
>To: techwr-l -at- lists -dot- techwr-l -dot- com
>Subject: Modular documentation
>
>Hi guys,
>
>
>
>I'd +love+ some advice on documentation tools for producing modular
>documentation.
>
>
>
>As of next month, my company are moving over to using a single code
base
>to produce all their products, so they can produce plain X, X with Y, X
>with Z, X with client A branding etc without having to work on four
>different versions of the code.
>
>
>
>Obviously, I'd like to do the same with the documentation. I can't use
>the simple expedient of having a document for X plus add-on documents
>for Y and Z, as adding Y and Z change a raft of things (providing
>additional options and the like) within the main product.
>
>
>
>What I'm going to need, therefore, is a source user manual with +all+
>the information in it, from which I can select whether to output any of
>the above combinations.
>
>
>
>I'm aware that this can be done with RoboHelp (being both lazy and
>apparently psychic, I already set it up to do this with our online
>help), but a) most of our manuals are currently in Word, and I've been
>given to understand that the conversion is a pig and b) if there's a
>better tool to use, since I'm going to be having to convert almost all
>our docset anyway, this is the time to change to it.
>
>
>
>The company is almost certain to go with whatever I suggest - after
this
>week, I'll be the only technical author here, and I report directly to
>both the VP of Engineering and the COO - so I want to make the +right+
>decision, as I and anyone else we take on in the future will be stuck
>with it :-)
>
>
>
>S.
>
>-----------------------------------------
>Sarah Bouchier
>Technical Author
>
>exony
>
>
>
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
>WebWorks ePublisher Pro for Word features support for every major Help
>format plus PDF, HTML and more. Flexible, precise, and efficient
content
>delivery. Try it today! http://www.webworks.com/techwr-l
>
>Easily create HTML or Microsoft Word content and convert to any popular
>Help file format or printed documentation. Learn more at
>http://www.DocToHelp.com/TechwrlList
>
>---
>You are currently subscribed to TECHWR-L as sarah -dot- bouchier -at- exony -dot- com -dot-
>
>To unsubscribe send a blank email to
>techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
>or visit http://lists.techwr-l.com/mailman/options/techwr-
>l/sarah.bouchier%40exony.com
>
>
>To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
>Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/techwhirl/ for more resources and info.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


References:
Modular documentation: From: Sarah Bouchier

Previous by Author: Modular documentation
Next by Author: Pagination in FrameMaker 7.0
Previous by Thread: Re: Modular documentation
Next by Thread: Outlook 2000 SP3 Question


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


Sponsored Ads