Apidays Helsinki 2023 - Master JIRA APIs: Essential Documentation Tips
Title: Docs-as-code at Atlassian: Jira API documentation
Speaker: Szymon Ozimek, Senior Content Designer at Atlassian
Szymon Ozimek, Senior Content Designer at Atlassian, shares invaluable insights on crafting high-quality API documentation that enhances software functionality and user experience. Whether you're a developer, technical writer, or a part of the Atlassian ecosystem, this presentation is packed with practical advice on using the DUX, the "documentation as code" paradigm, and integrating documentation into your development workflow.
🔍 *Learn:*
The essentials of JIRA API documentation.
Best practices for integrating documentation with development.
Tips for maintaining and improving API documentation quality.
#TechnicalWriting #DocumentationWorkflow #MarketingCommunication #DeveloperGuides #ContentDesign
#UserExperience #DocumentationEngineering #DeveloperFeedback #ContentApprovalProcess #ContentReviewProcess
CHAPTERS:
0:21 - Introduction to Our Process
1:34 - Working Methods Explained
5:31 - Writing Techniques Overview
10:16 - Previewing Our Content
13:15 - Review Process Insights
13:39 - Importance of Content Reviews
16:48 - Announcing New Changes
19:26 - Addressing Key Issues
22:35 - Interactive Q&A Session
*** Learn more and explore the depths of the API industry with additional resources:
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Deep dive into the API industry with our reports:
https://www.apidays.global/industry-r...
Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW
