This talk was presented at API The Docs Virtual 2020 event series on 6 May. We are glad to present the video recording, slide deck and talk summary below. Enjoy!
Visit our talk recaps ToC page for an overview of all presentations!
External performance metrics for API documentation.
Map documentation goals with all stakeholders, define success with metrics. Build a collaborative, iterative process.
The goals of your API’s audience vary throughout the life-cycle of their interaction with your API, so must the content and the corresponding measures of success.
“Start small, work your way up, identify your goals.”
Find your audience, define the goal of the documentation. Each content type serves different purposes and use cases: identify and serve these specific goals. Generalize content goals into a manageable amount: group the topics by their type.
Normalize metrics: baseball or golf scores? Count everything in the same direction for a usable dashboard. Non-funnel related metrics: will have to assemble tools your own way.
“In essence, creating an accessible developer portal ensures that you provide a better user experience to the wides… https://t.co/27qHNJQiSC