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 22 April. 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!
How to walk in the shoes of your readers?
MVD details:
The question you want to answer in your documentation is “Why would anyone use my API?” The answer is MVD. Keep it simple, so your readers can tell if your API works for them - in seconds.
Create a clear and easy-to-find landing page layout for your use cases, products, and endpoints with direct instructions on how to get to the endpoints.
Takeaway: If your user experience makes your user think, you are doing it wrong.
Action plan: Lay out API functionality and coordinate it with your use cases.
Serve the whole audience all at once, but give customers customized instructions for their particular needs.
Serve your use cases like in a buffet:
Action plan:
Takeaways: Swagger/OpenAPI Initiative reference documentation isn’t enough.
Action plan:
New hope for your users:
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