RE: Technical Documentation solutions?

Subject: RE: Technical Documentation solutions?
From: "Manley Clifford (GFD1CEM)" <GFD1CEM -at- ups -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 28 Aug 2002 15:45:11 -0400

I suspect that if there is a canned solution the Doculabs/Arbortext
coalition would be the closest to providing it, and may be looked at down
the road.

As far as dynamic documentation, in one particular instance, and without
getting too particular about my clients actual documentation content, I want
to maintain a table.

Column 1 is a list of applications (by acronym) that are running (monitored
by Tivoli Endpoints)
Column 2 is a list of application descriptions
Column 3 is a list of methods
Column 4 is a list of event handlers

So, for each row we know the apps acronym, description, methods and types of
event handling.

At this point this is an Excel spreadsheet.

Different engineers access it periodically and update their part of it: one
may add an application to the list of apps, another may add or remove an
event handler for an app.

Current practice calls for the engineer who adds/changes/deletes apps or
events then to update the table.

They hired me because the engineer is buried in engineering and rarely
fulfills his documentation responsibility. They wanted me to be the
documentation police, so the engineer could shoot me an email saying he
added an app with x monitors and I would go update the table.

I don't see that as a viable solution.

I want this document to be dynamic - to read the appropriate data sources so
that when an app is added/removed the document is updated.

I want the list of apps and list of monitors to be databased. The engineer
can access data in Oracle much faster than he can find the doc, update it
and go through version control to post it back to the document management
system. All the engineer has to do is update the database re apps running,
or events monitored, and the document will update itself.

I then want to publish that table on the intranet as a ready reference so
that any engineer can see what's running at any time.

For today, that's my goal. Sounds simple enough.

Got milk?

Want to support TECHWR-L? Get shirts, bags, hats, clocks,
and more from the TECHWR-L Store. All proceeds support TECHWR-L.

Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at

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 for more resources and info.

Previous by Author: RE: Technical Documentation solutions?
Next by Author: RE: Technical Documentation solutions?
Previous by Thread: RE: Technical Documentation solutions?
Next by Thread: RE: Technical Documentation solutions?

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

Sponsored Ads