Technical communication colleagues:
As a result of my xml studies, I’ve come up with the following philosophical outline for a successful documentation approach:
- Point to Document Type Definitions (DTDs) or xml schema files to ensure that documents are valid and well formed with the proper syntax.
- Create a controlled vocabulary and library of xml elements to support a structured documentation approach.
- Use name spaces to prevent tags with the same names but different meanings from colliding with one another.
- Define attributes to provide guidance on what must go into every element and what cannot be included.
- Write comments to describe the logic behind building the structured documentation approach.
- Standardize xml documentation with processing instructions and declarations.
- Build general entity references to modularize xml documentation.
Any additional thoughts or advice?