Category Archives: Knowledge Base

Firefox OS English User Guide

Today we begin a week-long celebration of our awesome Firefox OS Knowledge Base contributor community. So, I baked some brownies for all of you who contributed to any of the 16 help article sprints I’ve been hosting since last October in preparation for shipping the first Firefox OS devices. The result is a splendid Firefox OS User Guide.

brownies that say Congratulations! SUMO Firfox OS KB

As a salute to finalizing these articles for L10n, I went ahead and left in the typo! :) If only all of my typos were made of cream cheese frosting…

We started this project from nothing in October, just an outline (ok, a very large outline) of the scope of articles we should write. Today we have 50 clear, beautiful, helpful English knowledge base articles that were a collaboration between 24 KB editors and reviewers:

  • satdav
  • feer56
  • rtanglao
  • zombie
  • espressive
  • tjovanovic
  • iNerd
  • ariestiyansyah
  • yalam96
  • pychen
  • hermina_condei
  • willyaranda
  • adampeebleswrites
  • Tonnes
  • Swarnava
  • Scoobidiver
  • rnewman
  • mandel
  • bram
  • Tylerdowner
  • verdi
  • Ibai
  • KadirTopal

Congratulations and thank you to everyone who has made the Firefox OS KB project a success!! This hard work is the content of the Mozilla’s Firefox OS support pages, it is the in-product Help for Firefox OS in the Settings, it is already regarded as an excellent resource by our OEM partners and our carrier partners. Please please take a moment to just absorb that and the impact your contribution will have on Firefox OS users and the Mozilla mission. It is big. You are The Best. Thank you.

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.

One awesomely designed support center and what makes it rock

Cross-posted from djst.org:

Inspired by Desk.com’s article titled 12 Awesomely Designed Support Centers and What Makes Them Rock, I decided to take the opportunity to demonstrate why our very own help center, support.mozilla.org (SUMO) is way better than all of their twelve help centers combined. ;)

Although their article reads more as a showcase of some of the companies that happened to choose them as their support service provider (which we would never do, since our site is powered by our very own, superior and open-sourced CMS Kitsune), it’s still interesting to look at what they view as great design decisions in a help center to see how we compare.

Here are the main themes of their feedback that I distilled:

1. “The site looks great on all devices from mobile to desktop … The layout of the site is clean and makes it easy to navigate on any device”

We’re mighty proud of the mobile-optimized view of SUMO. It’s one of the most beautifully designed mozilla.org web properties ever made and it works across all mobile platforms. Bram did a fantastic job with the design, and it will fit our future Firefox OS support site like a glove:

You can try this out right away by navigating to support.mozilla.org with your Android or iPhone device. And if you’re one of the lucky few with a Firefox OS testing device, our site obviously works just as well there. :)

2. “The uncluttered design and iconography makes it easy to find information … The iconography makes topics easy to identify and stand out”

Our design uses beautiful icons to organize the content into help topics based on what users most commonly look for on our website. We tested this with paper prototyping before implementing it to make sure that the taxonomy and overall design was ideal for our unique product portfolio.

Our help topics area has beautiful icons

3. “The ability to view support center by topics or by articles is a great way to organize content … The organization of content makes it simple to find the exact answers you need”

We really went the extra mile on this one. In our user studies, we noticed that users have different behaviors when it comes to navigating to the answer to their question. Some people want to start by picking a general topic, while others prefer to pick the product they want support for first. As a result, we made sure that both of these orders work just as well on SUMO.

products and services

You can pick a topic and a product, and then we’ll show you a list of articles that matches that query. From that point, you can even filter that list down even further with the Refine and Focus feature, which allows you to pick from a more granular list of topics:

Our Refine and Focus lets you pick exactly the topic you need help with.

4. “The design is simple, clean and easy to navigate … The colors and typography are solid, strong and consistent with branding … The design is simple and clean and doesn’t distract from the important content”

The look and feel of SUMO is consistent with the overall design language of mozilla.org. This was a specific design requirement since support is an extension of the product experience. Also notice the language selector on the right — our site is available in multiple languages, and the localization is done by our amazing community of SUMO volunteers: people like our new Spanish locale leader Avelper, or my great friends and veteran Italian localizers Michele Rodaro and Underpass.

The typography and navigation elements are consistent throughout our web properties.

5. “The support center articles are well written and easy to understand”

We took great care to make sure that our articles are engaging, easy to understand and that they have a friendly tone. We also really considered the target audience and even the mood that they might be in when visiting our site (e.g. frustrated because they’re trying to figure out a solution to a problem). Great support is an important extension of the Firefox brand and the values that Mozilla stands for, so it’s important that we get this right. Our awesome content manager Michael played a huge role in making this a reality. Here are some of the support articles that capture these aspects well:

6. “There’s a ton of helpful information from community questions to how-to videos”

Videos are very powerful because they can convey lots of information very quickly and demonstrate features in ways that no texts or screenshots can ever come close to. It’s a bit like the difference between reading an article about how to play barre chords and just watching someone do it.

A video showing how to restore your previous Firefox session.

So there you have it! I love reading articles like the one on Desk.com because they make me realize just how far we’ve come at Mozilla with SUMO. Our support site is the result of lots of hard work by several teams, including of course the SUMO team, the SUMO dev team, and the UX team. And this year we’ll get even better — I’ll blog more about our plans for 2013 soon.

SUMO Write Help Articles Day, Thursday November 15th!

Thursday is SUMO Write Help Articles DAY! Woohoo!

Anyone and everyone can help! Here are the goals:

  1. Create new articles for Firefox for Android! Anything you want to write about is welcomed! We especially need articles about the Tablet UI if you have a tablet! Newbies encouraged, see the knowledge base getting started documentation! Just go to the New article page of the wiki and start hacking, I’m michelleluna in #SUMO on IRC if you need help or send me a private message (username mluna) if you get stuck.
  2. Update articles for Firefox for Android! The following articles need changes:
  3. Create new articles for Firefox OS! We have a list of three email articles that need to be created here with detailed instructions for how to get started (thanks Roland!). See Roland’s post for instructions on getting started even if you don’t have the Firefox OS! The forum thread also has a bunch of links to other ‘stub articles’ that we need to fill in, so hack away! If you think of it, use the ‘Administrative’ category for the article, so it won’t show up in the L10n dashboard, but no worries, I’ll check this during the article review also.
  4. Make needed updates to Firefox Desktop and SUMO contributor articles! The updates we need to make are in the Needs Changes list, you can literally help 100,000 Firefox users next week if you update two of these top articles!!

Reviewers goal:

  • Review all of the edits in the Unreviewed Changes list.

    Thanks for all you do to make the Mozilla Help Articles great!

    See you tomorrow!

  • SUMO now helping an additional 7.3 million visitors

    About 3 weeks ago we made the switch to a new information architecture and new design. The goal was to improve the browsability of the site and help people find the articles that they were looking for. 3 Weeks later we can now take a look at our key performance indicators to determine whether the whole project was worth the effort

    Methodology

    Since this project was primarily concerned with the Knowledge Base, we can focus on the helpfulness rating in this channel. Also, we know from our exit surveys that about 80% of our visitors use the KB.  The KB helpfulness rating is based on the survey that accompanies each article in each language. We ask the question “Was this article helpful?”, which can be answered with yes or no. Of course this metric is not perfect, articles that describe features have higher ratings than articles explaining how to fix a problem, English articles are generally higher rated than localized articles, despite having the same content, and the rating is also influenced by the path people took to get to the page. However, in this case we are not interested in the absolute ratings, we are particularly interested in the change since we moved to the new iA and design.

    So, what happened?

    We knew from previous tests that making the site browsable would be beneficial for that segment of our users who would rather browse than search for their article. People rate an article down, when it’s not the one that they were looking for. We know so much from our article surveys, and assuming we did our homework we should help more people find the right article. That being the case we expected the helpfulness of articles to rise, but it was hard to tell by how much it would rise. Considering that we have over 500,000 visitors per day and 80% use the KB, even a change by one percentage point would help an additional 1.46 million visitors per year. Without further ado, here are the results:

    The results are phenomenal, we raised the helpfulness by 10 percent on average. That’s an increase by 5 percentage points and means an additional 7.3 million visitors per year stating that they found a SUMO article helpful. This is across all languages and across all incoming channels. It means that in 7.3 million cases where people might have decided to drop Firefox or be miserable because they couldn’t get Firefox to do what they wanted, they will now leave SUMO satisfied with their browser.

    It’s hard to overstate the significance of this, and we are extremely happy with the results. The improvements to the site were the result of month of hard work by many people on the SUMO team, from SUMOdev, our creative team, and UX designers. We knew we were able to offer our users a better service, and the work has finally paid off. Continually thinking about how to serve our users better is what’s driving this team, and we will take these results as motivation to work even harder on improving our services.

    Today, I’m very proud of what this team made possible, and I’d like to extend my thanks to each and everyone involved in the process: You made these results possible!

    The all new SUMO

    Today we are going to make one of the biggest changes yet to SUMO, the Mozilla Support site, and this blog post is about what changes we are making. The changes will effect you the most as a user, but there are a number of changes for contributors as well.

    First, a little history, what’s the SUMO team been up to this year?

    For the last 9 month the SUMO team has been working on a new way to let users access our site content. Until recently the only way to reach most of our articles was by search, or by following links in articles. This is how wikis traditionally work. Of course that way of accessing content only works for a part of our visitors, some people want to search and some people want to browse to the solution, drilling down with ever finer topics to reduce the number of article that are related to the issue.

    To come up with a new information architecture that would let people drill down like that, we first researched the mental model of our site users, how they think about issues and in what categories they would look for them. Based on that we created a small number of base categories and assigned our articles to those categories.

    The next step was figuring out how to make this information architecture visible. We started to lay out a number of alternatives on paper and tested with real people in a lab. This paper prototyping gave us a way to test a number of ways to lay out the information very quickly. After a number of iterations we settled on the final designs and workflows.

    Now we had everything to start adapting our site, but since this would be a big redesign, and we’d soon switch to the new unified One Mozilla design anyway, the decision was made to use this opportunity to rebuild the site based on the new theme, and that’s why the changes today not only affect the KB, but every part of our site.

    So, what is changing? What does it look like?

    The main change is, that we now support several products from one start page and all articles can be accessed by browsing. Let’s start with the start page:

    We have the main topics on top, they allow you to start browsing by selecting your issue first, and then the product you have issue with.

    One step below you can see the hot topics. Those are actually articles, things that came up recently and affect a large number of people. By providing them upfront we save a large number of people the hassle of searching or browsing for their solution.

    Below that we have the product picker, this is a way to navigate our content by choosing the product first and then narrowing down the topics.

    No matter what way you select, topic first or product first, you’ll end up narrowing down the number of articles to a scanable few and proceed to read one of the articles.

    The important thing for localizers to note is: all of this is automated, there is no need anymore to create navigation pages and all the confusion that brought with it.

    So, how did the article view change? On the surface not much has changed, but because we keep track of topics, we can now offer you a way to move to related topics, which is particularly interesting for people landing on articles from external searches:

    Much, much more has changed, but this is the gist for the KB part of the site.

    So, what has changed for forum contributors?

    While the new iA did not touch the support forum per se, we took the redesign as an opportunity to improve a number of factors in the listing of questions for our contributors.

    The new design is more friendly and clean, but at the same time gives more information about the thread content at the same time. This is especially helpful when contributors scan the thread listing page deciding which thread to pick next.

    We already started rolling the design out to our contributor base over the last week and will start rolling it out to 1% of the general audience today. If everything goes to plan we’ll make it available to the general audience on Monday. If you want to try it out now, just register an account, and if you have any feedback, please use the comment section below.

    The new information architecture will open up our content to a whole new group of users and make it much more accessible, while our new design is more coherent, taking into account all of the features we added since our first release while also being consistent with the Mozilla sites in general. All of this makes us very excited and hopeful that we’ll get that much closer to our number one goal: Happy users!

    The 8th SUMO sprint

    Last Tuesday we finished the 8th SUMO sprint of this year. I’s been a short sprint, because for half of it Mozilla web developers met for a work week in California. Nevertheless we were able to land some great improvements to SUMO.

    1. One of our top priorities right now is improving our search results. To that end we started an initiative to rate KB and forum results as equals, based solely on the content instead of showing KB articles on top and forum posts at the bottom. We hope that this step will result in better search results by higher click through rates. This is a project that will take more than one sprint to be implemented. We completed the first of 3 phases in this sprint and are planning to implement the rest over the next sprints. You can read Will’s bug comment about it, if you want to know more about the gory details of the unification work.
    2. We were also able to implement a feature in the forums that gives our community an indicator for how we are doing and shows everyones impact on the forum: We call it the forum feedback indicator. It shows you how many questions were asked in the last 3 days and how many have a reply. It also links to the questions that haven’t been answered yet. The progress bar is orange, for any values below 100% and turns green when all questions are taken care of.

    As with every sprint we also fixed a number of annoying bugs, and you can always follow along on the excellent scrumbugs. Here is the list for the 8th sprint.

    However I’d like to point out one specific issue, that was bugging us in the forums for quite a while, creeping back when we thought we had squashed it: In some cases, a question displayed “No replies”, even though it already had replies. That bug is now hopefully fixed for good.