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 User Documentation Is Important

I bring this article to you courtesy of Scott Cooley, as I think it brings to you opinions from other technical writers around the world to help expose new trends and better thinking to the realm of User Documentation. You may view the original article here.

In previous blog posts, we’ve written a lot about the courses available in Deque University, but did you know Deque U is also the home of our product documentation?  These include comprehensive reference materials about our products, including user guides, quick reference guides, and automated rule information and remediation advice.  In fact, this user documentation often serves as the basis of much of the product training we do in order to ensure that everyone who uses our products is using them efficiently. In this post, we’re going to cover the importance of sections like the product resources side of Deque University. This part of Deque hasn’t been highlighted as much as our course offering, but it’s no less relevant.  That’s because the right product training is a huge part of cultivating self-sufficiency in web accessibility. Continue reading “Why User Documentation Is Important”

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 – User documentation in an Agile environment

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 – User documentation in an Agile environment”

The changing nature of content

I bring this article to you courtesy of Ellis Pratt, 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.

Technology has changed enormously over the last 70 years. But have technical communication standards kept up sufficiently to reflect these changes? It appears that some of the most successful software companies are breaking generally accepted best practice in technical writing – a trend that clearly should get us thinking.

If you were going back in time twenty or twenty five years and found yourself in a classroom learning about technical writing, you’d probably find it was almost identical to classes on this subject offered today. Technical communicators tend to assume that technical communication best practices, which have been taught for the past 25 years, and even further back in time, are still appropriate today.

Continue reading “The changing nature of content”

Ten things Clients should know about Technical Writing

I bring this article to you courtesy of Ron C 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.

As you might expect, technical writing is not just about writing. Certainly writing is a core skill, but depending on the job, the industry, and the purpose of the writing, a technical writer may wear many hats. Often tech writers’ responsibilities touch on editing, graphics, photography, formatting, marketing, training, designing, and document management/control, just to name a few. Continue reading “Ten things Clients should know about Technical Writing”

Great documentation saves money

I bring this article to you courtesy of Jacquie Samuels, 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.

GREAT DOCUMENTATION CAN SAVE YOU BIG BUCKS WHEN IT COMES TO SUPPORT BY JACQUIE SAMUELS

Let’s get back to the basics for a moment. Technical documentation has many diverse drivers, but ultimately, it all strives to perform one function: assist users so they can do what they want to do with the product. Sometimes they already know what they want to do, other times the documentation helps educate them.

Continue reading “Great documentation saves money”

Standard Operating Procedures

I bring this article to you courtesy of Marcia Weedon, 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.

THE WELL WRITTEN SOP – CRITICAL FOR CONTINUOUS IMPROVEMENT BY MARCIA WEEDEN

The well-written SOP provides the baseline against which thoughtful and effective improvements can be planned and implemented.

Many companies put off documenting their processes and procedures because they are too sheepish to admit that these are not yet in a state of perfection. Perfection, however, is never a requirement for the well-written SOP.

Continue reading “Standard Operating Procedures”

The Value of Documented Processes

I bring this article to you courtesy of Marcia Weedon, as I think it adds relevance to my documentation framework. You may view the original article here.

THE VALUE OF DOCUMENTED PROCESSES BY MARCIA WEEDON

Most companies start small with a dream of what they would like to become someday. Small companies take pride in “we wear many hats around here.” With relatively simple, straightforward processes and a few key personnel, it is easy to make changes and keep the business going.

Continue reading “The Value of Documented Processes”