DITA XML syntax
Solution: IDE such as XMetaL or nXML
Too complex a document architecture?
Concept
DITA XML enables productivity gains by reducing the source volume that the technical writer creates, translates and maintains, at the cost of greater complexity.
Definition
Section titled “Definition”DITA XMLA structured, modular XML authoring architecture built around the concept/task/reference typology and content reuse via conrefs and ditamaps.View in glossary → enables significant productivity gains by reducing the volume of content that the technical writer creates, translates, and maintains. However, this productivity gain involves increased complexity, as explored in structured and unstructured formats.
Trade-offs
Section titled “Trade-offs”While DITA XML projects are more complex, they are still less complicated than projects based on more traditional formats like FrameMaker. This is because DITA XML follows a logical architecture. As a result, the technical writer can rely on the predictable behavior of the tools used, avoiding the tricks and hacks needed to work around bugs or the erratic behavior of more cumbersome tools.
DITA XML is complex but predictable; traditional formats are complicated and erratic.
Examples
Section titled “Examples”The following overview presents the different levels of complexity introduced by DITA XML and the solutions that help the technical writer manage them more effectively:
Relationship management between atomic information building blocks
Solution: A dedicated CMS such as Componize or DocZone
XSLT stylesheet syntax
Solution: Graphical stylesheet creation software
For a small technical writing team, the primary challenge will be applying the company’s visual identity to the output. Other aspects can be managed without specialized tools, through effective communication and a series of best practices - one of the most important being the KISS principle of simplicity.