User Centred Documentation

I bring an excerpt of this article to you courtesy of Tom Johnson, as I think it brings to you opinions from other technical writers around the world to help expose new trends and also supports my own documentation framework approach. You may view the original article here.

Origins of user-centred documentation

User-centred documentation stems from user-centred design. With user-centred design, designers usually study their users in depth as they design products. Designers may do any of the following to get a better understanding of users:

  • Observe users in their own environment
  • Do task analysis to define the steps users take
  • Storyboard user workflows and goals
  • Do A/B testing with prototypes
  • Create personas that represent typical users
  • Gather feedback in usability labs, and more

The goal of user-centred design is to create a product that users love. Continue reading “User Centred Documentation”

Why agile teams should care about documentation

I bring an excerpt of this article to you courtesy of Tom Thompson, as I think it brings to you opinions from other technical writers around the world to help expose new trends. You may view the original article here.

You don’t do documentation, so why should you care about it? How about missed deadlines, buggy code, and unhappy users?

Believe it or not, an agile approach to documentation can address all these problems—but only if the whole agile team is on board. Here’s why everyone should care about documentation and how to do documentation right. Continue reading “Why agile teams should care about documentation”

The DocOps Trend

The DocOps Trend: Applying Agile and DevOps to Technical Documentation

I bring an excerpt of this article to you courtesy of , as I think it brings to you methods and experiences from other technical writers around the world. You may view the original article here.

The advances and benefits in Agile programming and Agile project management are making headlines and grabbing a lot of attention these days. But what about technical documentation? Continue reading “The DocOps Trend”

Deepening documentation’s value by simplifying complexity

Value arguments for docs and tech comm

I bring an excerpt of this article to you courtesy of Tom Johnson, as I think it adds relevance to what I am setting out to achieve with my documentation framework. You may view the original article here.

SUMMARY: Technical writers can also deepen the value of the documentation they create by focusing on areas of complexity to users. Complexity not only involves articulating the “string theory” parts of a system but also formulating the content in a way that users, regardless of their level, can understand. The task of simplifying complexity can only be achieved by leveraging many perspectives across groups; thus, focusing on simplifying complexity will also achieve goals around enabling information flow and improving the customer experience.

Continue reading “Deepening documentation’s value by simplifying complexity”