RT @DeliberateComp1: "How cognitive biases and ranking can foster an ineffective architecture and design" Don't miss out on… https://t.co/Njau4ATXn0
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!
Senior Technical Writer at Amazon Web Services (AWS)
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.
RT @DeliberateComp1: "How cognitive biases and ranking can foster an ineffective architecture and design" Don't miss out on… https://t.co/Njau4ATXn0
RT @DeliberateComp1: "APIs: Semi-permeable, osmotic interfaces" Don't miss out on @dawnahukanna's talk next week at the… https://t.co/rF2qm9E2WM
Deliberate Complexity 2022 features a series of three events organized by @pronovix with the intent to create a spa… https://t.co/5ZkCEKHS7S
Deliberate Complexity 2022 features a series of three events organized by @pronovix with the intent to create a spa… https://t.co/uFiX820fCE
Big thanks to @palantir and @pronovix for sponsoring the #drupal update project bot. This tool is a major reason… https://t.co/OVYevQEFLG