A treasure map for the doc – Exploring the discoverability of documentation¶
Description
My team makes mapping software for mobile computers, and has been doing so for 20 years. People use our apps to capture and verify information about their built or natural environments (for example: roads, poles, trees, buildings) for the purpose of understanding, maintenance or design work.
Our doc comes in the form of conceptual topics, API references, blogs, tutorials, videos, and technical articles. We have built up a lot of content, but as time progresses, it seems that the amount of documentation we offer is inversely proportional to the time that our users have available to sift through it.
Making content discoverable is now our biggest challenge. We must continue to find ways to weave our content together. Once our users get into the universe of our doc, we need to guide them towards that small gem of information that they need. What they need is a treasure map to get to that gem!
- Conference: Write the Docs Australia
- Year: 2020