Stay current with the latest in tech comm
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,300+ subscribers

Search results

Upcoming event:
I'm giving an API documentation workshop in Los Angeles, California, on January 23, 2020. Check it out on EventBrite.
Input needed:
I'm gathering data about trends in developer documentation for 2020. If you write docs for developers, please take this survey. (You can view the ongoing results here.)

New article in Simplifying Complexity: Reconstructing the absent user

by Tom Johnson on May 31, 2018 •
categories: simplifying-complexity

I have a new article in my series on Simplifying Complexity. This article talks about why reconstructing the absent users is essential to creating good documentation.

Here’s a brief summary of the article:

To write good documentation, you have to follow the most fundamental rule of writing: know your reader. The problem in tech comm is that the reader (or “user”) is absent, and there aren’t any direct measurable outcomes when users interact with the documentation. Consequently, tech writers suffer from lack of user knowledge and feedback, which cripples the ability to write good documentation.

Writing good documentation requires you to reconstruct the absent user through a number of techniques — web analytics, embedded surveys, milestone completions, support tickets, satisfaction surveys, and more. It is an iterative process where layers of information get added little by little to form an image of the user, like a 3D printer slowly building a face. By acquiring and analyzing this user knowledge, you can start to create documentation that meets user’s needs. This user knowledge, though mostly qualitative, provides the best measure for documentation.

Read more here: Reconstructing the absent user – the essential requirement for writing good documentation.

follow us in feedly