Learning how developers think, and other API doc insights: Podcast with Joe Malin
Length: 45 min.
Download MP3 (right-click and select Save As)
In this podcast, I talk with Joe Malin about a variety of topics within API documentation, including how developers think, best practices, and more. Joe is a former software engineer who turned to technical writing many years ago. He has worked at a variety of companies in API documentation roles, including 7 years at Google.
Here are a few of the topics we cover in the podcast:
- Why Joe turned from software programming to writing
- What kind of API documentation he is currently working on
- Best practices for API documentation
- The brilliance of REST APIs as a means of interchanging information
- Whether REST API doc is easier than platform-API doc
- How much programming a person needs to know to do API documentation, particularly Javadoc
- How developers think, and other insights gained from learning programming
- Benefits of using Github and other source control repositories to share documentation
- His response to someone who says, "Well if I could write code, I would be a programmer instead of a technical writer."
- Contributions tech writers can make with code samples, including style guides for code
- Applications for visual communication with code
Add a review for the "I'd Rather Be Writing" podcast in iTunes
If you like this podcast, please add a review for the podcast in iTunes. Just click this link, and then launch iTunes. Find and subscribe to the podcast in iTunes. On the Ratings and Reviews section, add a rating and optionally a review. This will help increase the visibility of the podcast in iTunes.
About Tom Johnson
I'm a technical writer based in the San Francisco Bay area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.