Re: object-oriented documentation

Subject: Re: object-oriented documentation
From: "Mark Baker" <mbaker -at- omnimark -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 14 Dec 1999 10:06:57 -0500

Anonymous Poster wrote

> It seems
> clear to me that we should be trying to figure out how to modularize and
> our documentation. For lack of a better term, I think of this as object
> oriented documentation.

Back in 1995, I coined the term "Component Based Information Development" to
describe this process. (See the Proceedings of SGML 96 for a paper
describing the basic idea.)

Component based is a better term than object oriented, since documentation
is not amenable to object oriented features such as inheritance or

However, the basic principles of object oriented or component based
programming apply here. Each object or component must be of a well defined
class and that class determines the rules for the construction of that
component and the interface between that component and others of the same
class or other classes.

You cannot implement well defined classes of information components in a
word processing or desktop publishing system, even one with a database back
end and the ability to chunk documents. These systems simply don't support
the required meta-data. A chunk of a document does not an information
component make, any more than a chunk of a program makes a object or a
software component.

I have successfully implemented a number of component based information
development systems using databases, markup and programming languages like
VB and OmniMark. It can be done with reasonable efficiency, but you cannot
buy it off the shelf.

The other systems that you and others have mentioned have great merit in the
much simpler process of developing new documents by managed borrowing and
revision. This process is easier to implement but does not scale well as the
number and variety of different outputs grows or the size of the information
set grows.

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: Re: "Two-track" documentation
Next by Author: Re: task-based DTD
Previous by Thread: Re: FWD: object-oriented documentation
Next by Thread: Re: object-oriented documentation

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

Sponsored Ads