Atlassian has rolled out a major redesign across its API reference pages, introducing a three-column layout and improved navigation to help developers access information more effectively.
- Three-column layout separates navigation, content, and code samples
- Progressive disclosure reduces information overload
- New version menu and clearer navigation for REST API versions
What happened
Atlassian completed a comprehensive redesign of its API reference documentation initially started in April, beginning with Jira Cloud and Confluence Cloud APIs. The update features a new three-column interface: a navigation panel on the left, detailed content in the middle, and relevant code samples on the right. This layout is intended to streamline the developer experience by organizing critical information more intuitively.
Along with the new layout, Atlassian introduced progressive disclosure to avoid overwhelming users with excessive data. Essential details like standard responses and top-level parameters are immediately visible, whereas additional information such as error responses and parameter descriptions require user interaction to be revealed. Improvements to typography and information architecture make the documentation easier to read and faster to navigate.
Why it matters
Developers often face challenges with complex API documentation, especially when information is dense and hard to navigate. By redesigning its API reference pages, Atlassian aims to reduce friction in developers’ workflows, enabling faster onboarding and implementation of its APIs. This can lead to increased developer satisfaction and broader adoption of Atlassian’s APIs.
The introduction of a version menu allows users to access documentation for multiple API versions in one place, eliminating the need to switch tabs or pages. Additionally, clearer labels indicating deprecated or experimental operations help developers avoid using unsupported or unstable features, which improves overall project stability.
What to watch next
Atlassian encourages developer feedback on the new API reference design to guide further refinements. Users can submit suggestions through the Atlassian Developer Community or via the feedback button directly on the new documentation pages. This engagement will be crucial in shaping future updates and ensuring the resources meet developer needs.
Looking forward, Atlassian is also working on ongoing improvements to its REST API, including better search capabilities and enhanced functionality in upcoming Jira releases. These enhancements, combined with improved documentation, are expected to simplify issue and project management automation for developers.