How to Work with API Technical Writers
A talk given by Ken Cenerelli from Google at the 2024 Austin API Summit in Austin, Texas.
When building an API, good developer documentation is a requirement. Developers experience your API through your docs and they can’t use the API without it. In fact, with no UI available your API documentation is your public-facing product. To create an awesome developer experience, your docs must be complete, consistent, and easy to use. Building a good API doc set means that developer teams and managers should engage with technical writers so they can deliver excellent projects.
This session describes:
– Why you should work with a technical writer
– How to onboard a technical writer onto your project
– How to set project expectations and timelines
– Why API documentation should be a priority for everyone
– Guidelines for how to work with us
----------
Get the latest API insights straight to your inbox, subscribe to Nordic APIs newsletter: https://nordicapis.com/newsletter/
