Upcoming event:
I'm giving an API documentation workshop in San Francisco, California, on November 19, 2019. Check it out on EventBrite and register today to receive a $100 early bird discount.Podcast: 10 myths about API documentation
In this podcast, I debunk 10 myths about API documentation. For example, some myths are that only engineers can write API docs, or that you have to write API docs by deciphering an engineer's source code. In this podcast, I go through these myths one by one with discussion and analysis.
Listen to this post:
You can download the MP3 file, subscribe in iTunes, or listen with Stitcher.
10 myths about API documentation
Here are the myths I address in the podcast.
- You must read source code to write docs.
- You’ll need to extrapolate sample code from one language to create code samples in another.
- You must be a former engineer to be competitive in the API doc space.
- Technical writers usually create the reference material (e.g., OpenAPI spec, Javadoc).
- Almost all job interviewers care about, when it comes to API doc jobs, is technical know-how.
- Developers can and will write if you implement a docs-as-code process.
- Because their role aligns with the audience, with API docs, developers are most suited to be the ones writing for other developers.
- API documentation and developer documentation are synonymous.
- Docs that look good are good.
- People will respect you more if the word “writer” isn’t in your job title.
In the podcast, I mentioned this NY Times article: In the Salary Race, Engineers Sprint but English Majors Endure.
Your Feedback
Here’s a short survey to see if you think these myths are generally true or false. (It would be best if you listened to the podcast first.) You can view the ongoing results here.
