This post is from the XebiaLabs blog and has not been updated since the original publish date.
Meet the New XebiaLabs Documentation Site
XebiaLabs’ new documentation website is easier to navigate, search, and read. It's also mobile-friendly.
At XebiaLabs, we take our customers' needs seriously. We're interested in continuously improving our users' experience of the XebiaLabs DevOps platform, which is we're always releasing new features and product design changes--so many, in fact, that it's been hard for the documentation side to keep up! That's why over the last year, we've tripled the size of our Documentation team, so they'd be sure to have the bandwidth they need to undertake a complete overhaul of our approach to technical content delivery.
Analyzing our Documentation
After growing the Documentation Team, we set our sights firmly on upgrading the XebiaLabs documentation website. Based on tickets from the XebiaLabs Support Team, input from our customers, and our own experience, we had a good understanding of the main issues with the old documentation site:
- Much of the content was out-of-date and inadequate for real-world use scenarios
- Version-specific content was highly demanded by customers
- The search engine did not allow users to target the content they required
- The navigation system was outdated and made it difficult to locate relevant content
To address these issues, we started several initiatives:
- Ran a series of workshops with SMEs where we reviewed content, tested it for accuracy, and revised it as needed
- Created a new website to hold our existing content, with a backend that allows us to use proper versioning
- Introduced a powerful new search engine that enables users to filter by product and version
- Partnered with the XebiaLabs UX Team to create a new design for the website
Implementing the New Design
The XebiaLabs UX Team were onboard and eager to help with the design of the new site. Below, XebiaLabs UX/UI Designer Bojan Kocijan discusses his design process.
Based on our user research, we determined the main pain points of the documentation site. This helped us make important decisions around organizing the content and making scalable, easy-to-use layouts for the new site.
We discovered that most users were using the search bar instead of the navigation system to find content, so we put a lot of effort into making the site easier to navigate. We added an easier way to find and interact with the most popular topics and broke down each main content area into categories and tiles.
Navigating the Content
We completely redesigned the site navigation and display categories and related topics on tiles. This helps remove the user’s cognitive load by grouping information logically, allowing them to drill down to the content they need.
We made it very easy to navigate to the specific version of the software our customers need in response to feedback that they often struggled to identify which parts of a topic were relevant to their platform configuration.
Reading the documentation
Based on UX patterns and best practices, we made sure that the content is easy to read. The website is also mobile-friendly and scales to all devices.
Check out the new site:
site-wide leave feedback in the comments section below.