The API The Docs podcast features recordings of the live Q&A sessions that follow the presentations from the API The Docs virtual conference: an event series for a community of people around the world who care about API documentation, developer experience and developer portals. To learn more about the API The Docs community and this event series, visit apithedocs.org
Where to listen
Change management on large & complex documentation sets
On 13th May in the API The Docs virtual event Sarah Day, technical writer at LaunchDarkly, shared how you can incorporate API documentation in the big picture for overall efficiency in your organization. Riley Siebel, director of Developer Experience at C3.ai, and Mark Winberry, director of US Operations at Pronovix, presented a case study on providing a good DX with docs-as-code regardless of your system’s complexity. In the Q&A panel, they reflect on their talks and provide further insights about the following topics:
Do you have any advice for tech writers in a larger organization who must get buy-in at multiple levels of leadership? How do you get understanding and support from other departments to help drive advocacy when getting buy-in?
Have you done any research about where to host an API's docs compared to the API itself?
What kind of documentation tool did you use before you moved to docs-as-code?
On 6th May Steph Mills from Splunk shared how you can create the best possible golden paths through the API woods, and how to reduce the need for users to stray from the path into the wilds. Bob Watson from AWS explained how you're able to meet the practical aspects of customer goals with your API documentation, and how to measure how well you meet them as your API and customers evolve. In the Question-and-Answer session after their presentations, they reflect on their talks and provide further insights regarding customer oriented API documentation and API use case documentation. Enjoy!
On 22th April Mike Jang from GitLab explored what an Minimum Viable Documentation is for RESTful APIs. Jenny Wanger explained that the way you name, design, and structure your APIs has a huge impact on usability. In the Question-and-Answer session after their presentations, Jenny and Mike reflect on their talks and provide further insights. Enjoy!