A philosophical approach to XML

Technical communication colleagues:

As a result of my xml studies, I’ve come up with the following philosophical outline for a successful documentation approach:

  1. Point to Document Type Definitions (DTDs) or xml schema files to ensure that documents are valid and well formed with the proper syntax.
  2. Create a controlled vocabulary and library of xml elements to support a structured documentation approach.
  3. Use name spaces to prevent tags with the same names but different meanings from colliding with one another.
  4. Define attributes to provide guidance on what must go into every element and what cannot be included.
  5. Write comments to describe the logic behind building the structured documentation approach.
  6. Standardize xml documentation with processing instructions and declarations.
  7. Build general entity references to modularize xml documentation.

Any additional thoughts or advice?

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s