Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / techpubs / User and task analysis – or, how do I start writing anyway

September 13, 2007 by annegentle

User and task analysis – or, how do I start writing anyway

My writing teammates and I are working through our favorite ways to start a project and do user and task analysis. The exercise forced me to write down what it is I do when starting a new project.

My formal training began in graduate school but my practical training happened at only two different companies, Rockwell Software and BMC Software.

But the basic principles I follow are: do task analysis by reading everything available about the feature, reading about the typical users (personas are great for this goal), searching the internet for examples of the features in use, and then interviewing people to fill the gaps in the information available to me.

Next, I start by outlining what topics should be written and if there is a set of templates available I will always use those to the fullest. I guess that my outline-first approach is why the TOC standards are important to me. If I’m editing existing content I keep the users’ goals in mind while editing.

I have used the Hackos and Redish book User and Task Analysis for Interface Design and I like it. Also, I have A practical guide to usability testing by Dumas and Redish on my bookshelf.

Usability is so integral to task analysis, which is why much on the web is usability-based rather than writing-based I believe.

Basic task analysis: http://www.usabilitynet.org/tools/taskanalysis.htm

Task analysis grid using an Excel spreadsheet: (Fixed link using archive.org).

I’m using this spreadsheet only slightly modified to analyze user tasks for setting up a certification program and it has been so helpful so far.

Six Steps to Better Interviews and Simplified Task Analysis:
http://www.adaptivepath.com/publications/essays/archives/000295.php

I’m sure that this post doesn’t capture all of the things I do when approaching a writing assignment but it helps to write it down and analyze my methods to look for improvement.

Related

Filed Under: techpubs, writing Tagged With: analysis, personas, task analysis, techpubs, usability, user analysis, users, writing, writing assignments

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in