Recording of API documentation workshop (REST and Javadoc) at tcworld India 2015
Here's a recording of the API documentation workshop that I gave at tcworld India 2015:
In this workshop, I cover the following:
- Overview of API documentation
- Deep Dive into REST API documentation
- Deep Dive into Javadoc API documentation
This is similar to other presentations I've given on API documentation, except that in this workshop, I finally get a bit into Javadoc during the last 30 minutes. I also have more activities.
Here's the slide deck:
Sponsored
If you just want to grab the audio, you can listen and download it here:
Listen here:
Special thanks to Michael Fritz at tekom for allowing me to post both this recording and my keynote recording.
By the way, if you're interested in learning more about API documentation, check out part one of the API documentation course created by Peter Gruenbaum on Udemy.
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.