Getting a job in API documentation can be tricky. What programming skills do you need to know? How in-depth does your technical knowledge need to be? What kind of authoring tools and methods are relevant for jobs in API documentation? In this podcast, I talk with Andrew Davis, a former technical writer who turned to (Read more...)
I recently surveyed technical writers to ask a variety of questions about API documentation. Rather than present a summary of the survey all at once, I am presenting the results of each question on a post-by-post basis, so that I can properly analyze and interpret the results of each question. Overall about 32 people participated (Read more...)
I’m trying to gather more information about common practices with API documentation. I created an informal, open survey about API Doc here.
It’s an openly editable Google Doc with about 10 questions. You can see others’ responses as you enter your own.
If you do any kind of API documentation, I need your participation in (Read more...)
The following is a guest post by Vinish Garg, an information architect with a background in technical writing who frequently works with startups.
A discussion on authoring tools invariably leaves the participants with at least one common opinion–they want to see something better in whatever tool (Read more...)
I measure download links for podcasts through Podtrac. I haven’t been doing as many podcasts as I used to do. But I checked my podcast stats the other day and was kind of shocked.
Typical download stats for podcasts in the past averaged about 700 downloads per episode. For example, take a look at (Read more...)