How is visual documentation (e.g., ship diagrams, navigation charts) created and managed in maritime using DITA?

November 10, 2023
|By Bryan Tipper

In the maritime industry, visual documentation such as ship diagrams and navigation charts is crucial for conveying complex information to crew members. DITA (Darwin Information Typing Architecture) provides a structured approach to create and manage such visual content effectively.

Structured Visual Documentation

Visual documentation in DITA is typically created as specialized topic types. For instance:


<diagram id="ship_diagram">
  <title>Ship Diagram</title>
  <description>Layout of a typical maritime vessel.</description>
  <image>ship_diagram.png</image>
  <source>Maritime Expert</source>
</diagram>

In this example, a DITA topic type “diagram” is used to create a ship diagram. It includes a title, description, image reference, and the source of the diagram.

Versioning and Updates

Managing visual documentation in DITA also involves versioning and updates. DITA allows organizations to track changes and revisions over time, ensuring that the visual content remains accurate and up-to-date. For example:


<diagram id="ship_diagram">
  <title>Ship Diagram</title>
  <description>Layout of a typical maritime vessel.</description>
  <image>ship_diagram_v2.png</image>
  <source>Maritime Expert</source>
  <version>2.0</version>
  <last-updated>2023-11-10</last-updated>
</diagram>

In this updated diagram example, a new version and last-updated date have been added to indicate changes or revisions.