Technical Writing and XML: Reconciling Editorial License with Structured Markup

In writing reference material, consistency of organization and presentation is key. If the same information is presented in a consistent order and style throughout the publication or information set, it enhances the readability and usability of the material for the consumer. Ease of use is vital. XML provides a means to assist in the standardization of reference material from both an organizational and a semantic/content-oriented standpoint. Standardization based on structure and content enhances the potential for reuse of the XML-tagged information for both print and electronic delivery.But while there can be a strong relationship between the authoring and editing of content and structured markup, all too often conflicts arise between technical writers and DTD/schema designers and programmers. The perceived need for editorial license and creative freedom by many authors/editors clashes with the need for rigid structure to facilitate ease of programming for markup technologists and programmers. The disagreements are commonly between format and structure, looseness and rigidity, and are often more philosophical than practical.

Rudder, Douglas. IDEAlliance (2004). Articles>Writing>Technical Writing>XML