“When you’re working on APIs that developers use, they need to know exactly how to use them. Great documentation is the way to do this & it gives development a chance to make things more user-friendly.” In this podcast, Milecia McGregor (Developer Advocate, Conducto) reviews why API docs are important and she also shares some tips about how to manage their development cycle.
Vonage’s developer platform journey started in 2017. Little did they know the impact that some of their design decisions were going to have now. In this interview, Fabian shares how the platform evolved over the years, what challenges the team needed to overcome and what new features are in the pipeline. Tune in to get some tips about separating the prose from the code, and find out what developer advocacy is necessary for the success of this new tool chain!
At the 7th API The Docs Virtual event Michelle Fredette, technical writer at New Relic and Chris Cowell, Oregon-based technical trainer and writer presented on the issues of onboarding writers with different knowledge gaps and how to solve them with 8 hours of training. Uwana Ikaiddi, Developer Documentation Manager at BigCommerce explained the significance of external and internal audience feedback, and gave guidance on how to improve API documentation by them. In the Q&A panel of the event, they reflect on their talks and provide further insights on:
- Do you also train your developers on how they can document for themselves?
- What would you recommend for people who want to change career-path from development to techwriting?
- Is there a need for anti-personas, i.e. people who aren't specifically the core audience of the API documentation but might need to consider when writing the docs?
- How to build trust with your internal audience?
- Can you speak to techniques who are getting collected external feedback to the appropriate writers on a large writing team?
- Does teaching developer students technical writing support a faster and more efficient on-boarding process in the long run?
At the 6th API The Docs Virtual event Egan Anderson, head of developer experience at Galileo, explained ways companies can prioritize developers’ needs. Larry Kluger, lead developer advocate for DocuSign, presented how to create easy to use graphical drag & drop tools for creating and trying complex API requests. Michael Haberman, co-founder & CTO at Aspecto, explored maintaining API production while using microservices to collect data and by that, help development and testing phases. In the Q&A panel of the event, they reflect on their talks and provide further insights on:
- What are the milestones in API documentation processes?
- How to make sure all advocates are being heard during the development?
- How to boost morale & excitement in an internal audience when it comes to API initiatives?
- Which is a better approach: design-first vs. code-first?
- Why use Blockly library for API exploring?
- Is there a need to develop own libraries for open source APIs?
- How to make your APIs self-documenting?
- Which are the instances when reducing the number of your services is recommended to maintain your system?
On 27th Tom Johnson, senior technical writer at Amazon, presented his comprehensive research on how API documentation trends differ from other tech comm trends. In the Q&A panel, he reflects on his talk and provide further insights on:
- What methods does your team use to estimate time for creating a documentation?
- How to improve the dynamics inside and outside of your documentation team?
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?