10 Key Mistakes In Your API Docs and How to Avoid Them - API conference 27th April 2023

In this talk, we will reveal common mistakes you should avoid while creating API docs and developer portals. Anil will share some tips and tricks on what it takes to build a great developer portal that developers will love to use. This talk will present some good examples of various developer portals and use cases.

Transcript

1. 10 Key Mistakes In Your API Docs and How to Avoid Them By Anil Kumar, Lokalise @anilbms75
2. Could you share how your experience at this conference has been thus far?
3. 👏👏 👏
4. Experience
6. 1. Skipping Feedback: A Missed Opportunity
8. Next Js Documentation Feedback Source: nextjs.org/docs
9. Lokalise Developer Hub Feedback From
10. Lokalise Developer Hub Feedback From
13. 2. Ignoring Diverse Personas
14. @anilbms75 Image: APIMatic
15. @anilbms75
16. What percentage of developers learn how to code using HOW TO VIDEOS? A. around 25% B. around 59% C. around 10% D. around 95% ✅
17. 3. Applying User Experience Technique To Developer Experience
18. @anilbms75 DEVELOPER EXPERIENCE (DX) is not same as USER EXPERIENCE (UX) DX is for Makers UX is for consumers
19. @anilbms75
20. 4. Overlooking Developer Needs
21. @anilbms75 “People don’t want a quarter-inch drill. They want a quarter-inch hole.” - Theodore Levitt
22. Train ticket Image source: wikipedia
23. Netflix Image source: undraw
24. Flixbus Image source: wikimedia
25. @anilbms75
26. @anilbms75
27. 5. Delaying Delight
31. @anilbms75
32. @anilbms75
33. 6. Lost in Troubleshooting: The Missing Guide
34. @anilbms75 Source: swyx.io
37. Jenni Nadler, Head of UX writing @ Wix
38. 7. Essential Support Information Missing!
39. @anilbms75
40. 8. Unclear Terminologies
42. @anilbms75 Why Your API Doesn’t Solve My Problem: Putting Use Cases First - Jan Vlnas, Superface
43. @anilbms75
44. @anilbms75
45. @anilbms75
46. @anilbms75
47. @anilbms75
48. 9. Missing Community Opportunity
49. @anilbms75
50. Celebrate the contribution Source: github.com/contentful/forma-36
51. 10. Not enough user testing
52. Image: unsplash @anilbms75 “If you want to know what a person really values, what they really suffer, what they really do, don’t listen to their words, observe their actions” - Amy Hoy, Sales Safari
53. @anilbms75 Source: jpattonassociates.com
54. @anilbms75 Source: jpattonassociates.com
55. @anilbms75
56. @anilbms75 Image: Undraw Friction Log Technique
57. Image: unsplash @anilbms75 “You don't need to have ideas to innovate; you need to be a good receiver of ideas.” - Brian Chesky, CEO of Airbnb
58. Thanks Twitter: @anilbms75 Email: anilbms75@gmail.com Linkedin: linkedin.com/in/anilkrishnashetty