Writing and updating articles

Planet Mozilla viewers – you can watch this video on YouTube.

This is a followup to my post, “What should we document?” and is part of our technical writing program for SUMO.

Now that we have our list of what needs to be documented, it’s time to get started. All of the documentation that I talk about in the video can be accessed from this article – Improve the Knowledge Base.

If you have suggestions for making this particular workshop better, please reply to this thread in our knowledge base forum.

What should we document?

Planet Mozilla viewers – you can watch this video on YouTube.

This is a followup to my post on figuring out what’s new in Firefox and is part of our technical writing program for SUMO.

Once we’ve figured out what changes will be visible to users, we have to figure out what articles need to be written or updated. Here’s how I figure that out:

  • First I determine what changes need to be documented. Not every change needs to be documented (or at least, documented on SUMO).
    • Here are some things we generally DON’T document:
      • Developer tools
      • Changes to our support for web standards (like unprefixing a new CSS element).
      • Minor visual changes. In the past we’ve made the outline of buttons more or less prominent for example without updating our documentation.
      • “Under the hood” changes like speed improvements and new javascript engines.
    • Here are things we DO document:
      • New features like Facebook Messenger or Firefox Reset.
      • Changes to existing features. Our site supports showing different sets of instructions to different operating systems and different versions of Firefox. In this way we can customize the article to match what people are using. Look at the Startup, home page and download settings article and switch the controls at the top from Firefox 18 to Firefox 17 and you will see that there is a section about add-on for Firefox 17 that isn’t there for Firefox 18.
      • Problems or questions we anticipate people will have. For example, Click to play blocklisting or ending support for Firefox 3.6.
  • Next I look at each change that needs to be documented and decide if it needs a new article or just an update to an existing article. Generally, if we already have an article on a topic, we probably just need to update it. New features or new problems generally require new articles. Occasionally it’s a little more complicated and we’ll have to discuss the best course of action.

If you have suggestions for making this particular workshop better, please reply to this thread in our knowledge base forum.

Figuring out what’s new in Firefox

Planet Mozilla viewers – you can watch this video on YouTube.

Rosana and I have been working to build a technical writing program for SUMO. We now have a group of four participants so I posted the first workshop – researching what’s new in Firefox. Here are links to the resources I talk about in the video:

If you have suggestions for making this particular workshop better, please reply to this thread in our knowledge base forum.

User Education

When I started working on our support documentation back in 2010, our users found it helpful about 50% of the time. So we went to work on creating a better manual. That involved a lot of things including changing they way we wrote and the way we organized things. Today users say our articles are helpful 75% of the time.

That’s a pretty great improvement (we think we can do even better) but one thing I noticed was that there was another important factor at work – where and when someone is pointed to an article. By far, the biggest spikes in our helpfulness rating come when someone points a reader to one of our articles. When you already have a person engaged in a topic and then say, “you should look at this because it will help” they not only do, they often find those articles helpful 90% or more of the time. These are classic teachable moments and I think it’s incredibly important to make use of them whenever possible.

Here are two examples of things that people hadn’t gone out of their way to learn about but when they were pointed to the articles in another context, they responded enthusastically. Back in February, The Den blog pointed to an article about choosing passwords. Now people don’t really ever look for this article on our support site. But when they read about it in this one blog post, 88,000 people clicked though and rated it helpful 95% of the time.

And more recently, Facebook started linking Firefox 3.6 users to this article in an effort to get them to upgrade. Over the last two months more than 1.1 million people have visited and rated that article helpful 95% of the time. We’ve also seen this kind of response when linking to articles about new features on the page that Firefox shows you after updating.

It’s important to have a great user manual. Kathy Sierra made the point over and over again that the way to create passionate users is to teach them how to kick ass. And, especially for something like a web browser that people expect to open up and have it just work, it’s critical to incorporate that teaching (in the browser or externally) in the right context – at the moment someone wants or needs it. That’s a much better experience than stopping what you are doing and trying to sift though an entire internet full of information. Who has time for that?

This is something that I’m extremely excited to be working on over the next year as part of the Support Team’s goal of creating an amazing support experience for all of our products.