Re: Object-Oriented Documentation

Subject: Re: Object-Oriented Documentation
From: Sheila Carlisle <scarlisle -at- axialinfo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 21 Jul 2003 10:16:31 -0700


One way to do what you're envisioning is to use a publishing automation approach with FrameMaker, very possibly combined with a database to manage the process.

For example, you could have a set of "manual profiles" in the database; each profile would contain the details of the specific content. This could also be a "customer-specific" profile. This info would be exported as an XML file, which would then be used in a dynamic process to pull together pre-existing FM "excerpts", apply user-selected formatting, and poss. combine with content from any other database content, e.g. developer's reference material.

Unless you distribute FM docs themselves, you'd probably be generating either PDFs or HTML/XML or online help as the output, so the complete FM docs become literally throw-aways, to be regenerated on-demand.

Even using a minimalist approach, anyone in the company could generate manuals on demand, as needed, letting the tech writers concentrate on content rather than production.

Sheila


Julia Stein wrote:

Our group is looking at ways to make our technical
documentation more object oriented.
Currently, we use FrameMaker 7 to write user manuals,
which consist of conceptual explanations and
procedural steps for using features.
Our requirements are to be able to extract only the
conceptual information, or only the procedural
information, at a moment's notice.

<snip>
we'd like to be able to offer a variety of manuals,
not just the two kinds we're envisioning now.

<snip> a
higher level of "automation" would help us keep up.


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

NEED TO PUBLISH FRAMEMAKER CONTENT ONLINE? "Mustang" is a NEW single
sourcing tool for FrameMaker that lets you easily publish your content
online. No macro language required! http://www.ehelp.com/techwr-l3

Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See www.mercer.edu/mstco or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-
---
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: Re: Word-to-XML/SGML tools
Next by Author: Looking for a mouse support group
Previous by Thread: RE: Object-Oriented Documentation
Next by Thread: Using RoboHelp to create Oracle Help for Web


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


Sponsored Ads