tekom - Tagungen

Docs-as-code at Atlassian: Jira API documentation

  • Fachvortrag
  • Softwaredokumentation
  • 16. November
  • 15:00 - 15:45 PM (MEZ)
  • C4.2/3
  • beendet
  • Szymon Ozimek

    • SeaChange Polska Sp. z o.o.

Inhalt

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.

Das lernen Sie

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

Vorkenntnisse

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

Referent:in

Szymon Ozimek

  • SeaChange Polska Sp. z o.o.
Biografie

Szymon Ozimek is based in Warsaw, Poland. He currently holds the position of Senior Content Designer at Atlassian, where he is responsible for creating and maintaining content related to Jira API documentation. With his prior experience working at the Warsaw Stock Exchange, Roche, and several technology companies, he has gained valuable knowledge and expertise in the field. His experience in these industries has allowed him to develop a deep understanding of the importance of maintaining clear, accurate documentation. As the owner of the Jira API documentation, Ozimek takes great pride in ensuring that the documentation is comprehensive, user-friendly, and up-to-date.

Szymon Ozimek is based in Warsaw, Poland. He currently holds the position of Senior Content Designer at Atlassian, where he is responsible for creating and maintaining content related to Jira API documentation. With his prior experience working at the Warsaw Stock Exchange, Roche, and several technology companies, he has gained valuable knowledge and expertise in the field. His experience in these industries has allowed him to develop a deep understanding of the importance of maintaining clear, accurate documentation. As the owner of the Jira API documentation, Ozimek takes great pride in ensuring that the documentation is comprehensive, user-friendly, and up-to-date.