Podcast: The upcoming tcworld India conference on March 12-13, with Akash Dubey


Length: 25 min. Download MP3 (right-click and select Save As) This weekend I talked with Akash Dubey, one of the main organizers of the tcworld India conference, about the upcoming conference in India. Although I haven’t mentioned it on my blog yet, this year I’m actually attending tcworld India as an invited keynote presenter. tcworld Continue Reading »

Why do we need PDFs?


I’ve never been a fan of PDFs, but PDF output is usually a requirement someone invariably brings up for documentation. In some cases, often for unstated reasons, users will ask for a PDF, and product managers expect technical writers to deliver one. When I get these requests, I usually create a zip file of the Continue Reading »

Upcoming workshop: Creating Interactive Video Tutorials, with Bernard Aschwanden on Feb 21


If you’re in the San Francisco Bay area and are interested in learning how to create interactive video tutorials, we have a workshop just for you. The STC Silicon Valley chapter is hosting a workshop titled Best Practices when Creating Interactive Video Tutorials. The workshop is led by Bernard Aschwanden — a consultant at Publishing Continue Reading »

Best practices for API documentation — podcast with Andrya Feinberg


I recently talked with Andrya Feinberg, a documentation manager and content strategist for Emotient, about best practices with API documentation. Below is a writeup Andrya has provided that summarizes some of the points she makes in the podcast. Length: 42 min. Download MP3 (right-click and select Save As) Here is Andrya’s summary of the best Continue Reading »

Survival strategies for API documentation — slides and recording


I’m gave a webinar to the Southern Ontario STC on Monday, Feb 2. This post contains the slides and recording. Webinar description Survival strategies for API documentation If you’re documenting an API for the first time, you may be in survival mode just trying to decipher the code, unravel developer speak, and publish a coherent Continue Reading »

Creating context-sensitive help by converting your help into a JSON API with Jekyll


I’ve written a lot about documenting APIs, but what if your documentation itself could function as an API? By this I mean, what if you could give developers an endpoint through which they could retrieve different parts of your documentation? This setup would work well for context-sensitive help within an application. I stumbled across a Continue Reading »