Help us help you find what you need faster - A quick experiment

Thanks for reaching out to the community @ShionaWebster!

I have completed the study and found the deep nesting of menus generally makes it difficult to find things. Some groupings, like the “legal” menu under “essentials”, did not make sense to me at all.

In my opinion, Atlassian’s developer docs need a clearer structure in general. They are too heavy on tutorials, which are inherently hard to search, are outdated the day after they are published, and require a lot of work to maintain (I have voiced this opinion before). Instead, the focus should be more on guides and references that generally don’t change so fast and provide much more depth than a tutorial ever can.

This website is a fantastic resource on how to write and structure technical documentation: https://diataxis.fr/. It may also be worth taking inspiration from big doc sites like Google Cloud, which, in my opinion, do a fantastic job of structuring content into guides, references, samples, and resources for each platform service offering.

6 Likes