For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

Search results

Two upcoming API documentation events this Thursday

by Tom Johnson on Feb 16, 2016
categories: api-doc

There are a couple of events on API documentation happening this Thursday. First, I'm giving an STC webinar on best practices for REST API documentation at 11am PST. Also, Andrew Fuchs is also presenting on API documentation at a Write the Docs meetup in Redwood City at 6:30pm PST.

This Thursday I’ll be giving an STC webinar titled Best Practices for Documenting REST APIs.

Best Practices for Documenting REST APIs

I know I’ve been focusing a lot on API documentation lately on my site, and it seems I’ve given dozens of different API doc presentations over the past couple of years. In this presentation, I’m going to try to distill the essence of my API documentation course in about 45 minutes. I might try to record a practice run of the webinar as well.

Sponsored

On the same topic of API documentation, if you’re in the San Francisco Bay area, this Thursday the Write the Docs group is also holding a meetup on API documentation in Redwood City. Andrew Fuchs from Google will be presenting.

Write the Docs meetup on API documentation

About Tom Johnson

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.