Archive for the "via Feed" Category

API technical writing course on Udemy, from Peter Gruenbaum, and some thoughts on documenting JSON

Peter Gruenbaum’s API technical writing course on Udemy is an excellent starting point for learning API documentation. He explores one of the more difficult parts of API documentation, which is describing JSON and XML data structures (usually in responses). Finally, a course on API doc One of the frequent questions people ask me is where (Read more...)

Switched commenting systems to Disqus

Just a heads up, with comments on my blog, I’m now using Disqus as opposed to the native commenting system in WordPress. This means you’ll need to log in using one of the four methods provided by Disqus (Google, Twitter, Facebook, or Disqus) to leave a comment. Why did I switch from WordPress’ native comments (Read more...)

API Documentation presentation to East Bay STC chapter — slides and recording

The other week I gave a presentation on API documentation to the East Bay STC chapter. Here are the slides and recording. API Documentation presentation to East Bay STC Chapter from Tom Johnson Here’s the PowerPoint version of the slides. Here’s the MP3 audio file: Links to more information This presentation is similar to other (Read more...)

Introduction to technical writing — slides and audio recording

A few weeks ago I gave a presentation to a small group of beginning technical writers in India. The presentation was a 20 minute introduction to technical writing, and I gave the presentation over Skype. Slides Here are the slides: Audio recording Here’s the MP3 audio file: Links to more information This presentation is similar (Read more...)

How to design documentation for non-linear reading behavior

To account for non-sequential reading behavior, provide your readers with sufficient context to orient themselves with your topic. This is the third post in my series about user-centered documentation. First observations about non-sequential reading In the late 1980s, John Carroll observed non-sequential reading behavior with how people consumed documentation in his seminal book, The Nurnberg (Read more...)

Other Stuff