tekom - conferences

Docs-as-code at Atlassian: Jira API documentation

  • Presentation
  • Software Documentation
  • 16. November
  • 15:00 - 15:45 PM (CET)
  • C4.2/3
  • finished
  • No presentation slides uploaded
  • Szymon Ozimek

    • Atlassian

Content

This is a case study on how the teams at Atlassian work on the API documentation for one of the world's most popular project management tools, Jira.

The presentation covers the entire process of documenting changes to the API, from writing the words, to pushing your changes to the git repo, reviews, the build process, and announcing the changes to the world. We're also going to talk about non-tech processes surrounding the doc production flow.

Takeaways

Learn about Atlassian's Jira API doc process: writing, reviewing, building, & announcing changes. Discover tools, processes, and best practices.

Prior knowledge

The audience should have some familiar with the terminology surrounding the docs-as-code approach.

Speaker

Szymon Ozimek

  • Atlassian
Biography

Szymon Ozimek is a Senior Content Designer at Atlassian. He is the owner of the Jira API documentation. His previous professional experience includes working at the Warsaw Stock Exchange and Roche. Based in Warsaw, Poland.