Re: customizable documentation

Subject: Re: customizable documentation
From: "Mark Baker" <mbaker -at- omnimark -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 13 Jan 2000 11:52:07 -0500

Philomena Hoopes wrote

> One of our customers, having received their first documentation in PDF
> format, proceeded to ask whether they could have editable files.
> Specifically, they want to change the references to system-assigned field
> names, substituting their customized names.

I experimented many years ago with a program that could be distributed to
customers who bought highly customizable telephone sets. The idea was that
they would use the program to enter how their telephone sets were programmed
and then push a button and have custom user guides printed from their office
printer. The prototype worked fine, but it wan never developed.

This is how I would do it today:

Store the documents in either in a database or in some form of markup (XML
or SGML).

Write a web application in OmniMark that would take the customization
information from the user, query the database or parse the markup, and
prepare a customized version in XML form.

Next, depending on the user's selection, the OmniMark program would either
generate an HTML page with the customized information included, or generate
a TeX file call out to TeX to produce PostScript or PDF to deliver to the
customer. This file would be sent back to the customer via their browser.

This way, you give the user the ability to do the customization they need,
you don't give them source files, and you ensure that your corporate
standards are met in all documentation that bears your company name. This
method will also be easier for the customer use, and less error prone, than
having to edit the files themselves.

Mark Baker
Senior Technical Communicator
OmniMark Technologies Corporation
1400 Blair Place
Ottawa, Ontario
Canada, K1J 9B8
Phone: 613-745-4242
Fax: 613-745-5560
Email mbaker -at- omnimark -dot- com

Previous by Author: Future skills
Next by Author: Re: Online customizable documentation
Previous by Thread: Re: customizable documentation
Next by Thread: Re: customizable documentation

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

Sponsored Ads

Sponsored Ads