The key to writing good documentation: Testing your instructions

Recently, in the rush to meet deadlines, I had to put aside one of the principles of technical writing I value the most: testing all the steps in my documentation, exactly as a user would.

Walking through all the steps in documentation yourself, as a technical writer, is critical to producing good documentation. But the (Read more...)

The key to writing good documentation: Testing your instructions

Recently, in the rush to meet deadlines, I had to put aside one of the principles of technical writing I value the most: testing all the steps in my documentation, exactly as a user would.

Walking through all the steps in documentation yourself, as a technical writer, is critical to producing good documentation. But the (Read more...)

Three questions people ask me each week

Question 1

The first question goes something like this:

Hi Tom, I found your blog and really like the content. I’m currently a ________ with a degree in _______. I’ve been working for the past few years doing ________. However, I really dislike my job. I realized that it involves _______ and _________ all day (Read more...)

Slides, notes, and lessons learned at the STC Summit 2015 in Columbus, Ohio

Slide presentations

Here are the slides from my workshop on REST API documentation. I have two sets of slides:

Documenting REST APIs from Tom Johnson

For detailed notes, see Documenting REST APIs.

Publishing API documentation — Workshop from Tom Johnson

For detailed notes, see Publishing API documentation.

I also gave a presentation that (Read more...)

How to avoid early death from sitting down all day

I'm growing increasingly nervous by the number of studies that show how sitting down all day poses health risks equivalent to smoking a pack a day. Just google sitting all day is the equivalent to smoking and you'll find plenty of articles.

I decided to download Break Time from the App store.

Break Time

So far it (Read more...)

Back to Top | Comments Off

Other Stuff