In December 2014, I published an informal survey to gather some basic information about API documentation practices. I used an open, short-answer style with 10 questions listed in a Google doc. About 43 people participated, though not everyone responded to every question.
If I were doing this survey again, I would clarify some of my questions. Still, the responses were valuable and painted a good picture of how API tech writers author and produce content.
Here are the 10 questions. In a series of blog posts, I elaborated on the meaning of the responses at length. For brevity here, I've included only the screenshots of the responses.
If you would like to contribute back to say thank you for the API documentation course, click the Donate button below. Alternatively, to contribute content, such as a tutorial or a new section, contact me with your ideas. You can also submit a pull request in the GitHub repo to make your contribution. Even if you want to just fix a typo or add a sentence here and there, it's always welcome.
Get new posts delivered straight to your inbox.
© 2017, Tom Johnson