Podcast: API Design and Usability with Arnaud Lauret (API Handyman)
Listen here:

Podcast topics
Here are some of the API design/usability topics we chat about in the podcast:
- What API usability is, and how usability is the same/different with developer tools
- How writing documentation tests the usability of a product
- What tech writers should look for to know whether an API is designed well
- What to call each of the components in an API (e.g., whether the term “endpoint” should be used)
- How tech writers can influence design and usability when they’re so far downstream in the development process
- Best practices for creating tutorials on API doc sites
- Spec-first design versus auto-generating the OpenAPI from the code
- Which framework you would you choose to work with to render the API spec
- Whether we’ll eventually move into a state where manually editing the OpenAPI spec code by hand becomes antiquated
- The Open Map visual diagram that shows the OpenAPI structure
- Recommended APIs that we should learn from and why
- Why providing the OpenAPI spec is important even if you don’t generate your docs from it
- How tech writers might interact with their company’s API style/design guide and why
- Whether the reference content and user guide should be separate or seamless
Sponsored
Resources
- The Design of Web APIs (book)
- API style book
- OpenAPI Map
- API Handyman blog
- @apihandyman (Twitter)
- API Developer Weekly newsletter
- WebAPI Events
- DBS Developer Portal
- Visual Code Studio
- Swagger Viewer extension
- openapi-lint extension
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.
If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.
Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.


