DITA Concept Topics

Concept Topic Illustration

Context

I wrote these concept topics in Oxygen XML Author. They represent the first stage of a bigger project that I was leading. The project started based on customer requests and included initial research to collect information, starting a documentation update initiative for over 100 services, tracking the initiative progress in Jira, and consulting a large number of authors about how to comply with the updated documentation requirements. As a result, services’ documentation sets were updated to better respond to the customers’ information demand.

My role

  • Did the initial research.
  • Started the documentation update initiative and wrote a wiki with more details.
  • Created a flowchart to help authors determine if the initiative is applicable for them.
  • Consulted authors about the documentation update requirements.
  • Created a Jira epic and the required number of issues to track the progress of the initiative for each service.

Tools

  • Jira
  • Confluence
  • Oxygen XML Author
  • Microsoft PowerPoint