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.
What are the practical aspects of customer goals, how can you meet them with your API documentation?
How to measure how well you meet customer goals as your API and your customers evolve?
What are the key phases of customers’ interactions with your documentation from the readers’ perspective?
What you should monitor, watch out for, and what you should ignore?
API Documentation examples
“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.