How are post-production documentation audit trails and edit logs managed in DITA?

Managing post-production documentation audit trails and edit logs is a critical aspect of using DITA (Darwin Information Typing Architecture) for film editing projects. These audit trails and logs help in tracking changes, ensuring accountability, and maintaining a history of document revisions.

Documenting Changes

In DITA, audit trails are typically maintained within the documentation topics themselves. Each topic includes a section where changes are documented. This section can include details such as the date of the change, the name of the person who made the change, and a brief description of what was modified. This information creates a historical record of all edits and updates to the document.


Here’s an example of how changes can be documented within a DITA topic:

<topic id="visual_effects_guidelines">
  <title>Visual Effects Guidelines</title>
  <reviewed-by>John Doe</reviewed-by>
      <author>Jane Smith</author>
      <description>Updated section on CGI techniques.</description>
      <author>Mark Johnson</author>
      <description>Revised recommendations for green screen usage.</description>

In this example, the “visual_effects_guidelines” topic has a “changes” section that records two changes made by different authors. This information allows for transparency and accountability in managing the documentation.