Knowledge Base discussions

Article Topics

  1. We've had this idea of article "Topics" since we built the new KB last year but haven't really used it because they weren't localizable. Now they are and we're going to start using them.


    What do topics do?

    • They allow us to automatically suggest a few related articles at the top of an article and again at the bottom in the "Couldn't find what you were looking for?" section.
      • We currently use just the "mobile" topic on mobile article and the related list is made up of other articles in the same category (how-to or troubleshooting) that also have the same tag.
    • They will also (soon) allow us to filter searches from the various start pages to articles with a particular topic. For example, the search on the mobile start page will only return documents with the "mobile" topic.
    • All of the articles in a particular topic are listed on a special "Topic page." An early mockup looked like this but the current implementation looks like this (more about this below). By linking these topic pages from the start pages we can give people browsing the site (versus searching) more ways to get to the content they are looking for.


    What topics should we use?

    For search filtering (Relevant to) we'll use:

    • desktop
    • mobile
    • sync
    • FxHome

    These topics already exist and are look exactly like that.

    In addition, I'm proposing we create and use the following topics:

    Do you think there should be other topics or that any of these should be called something else?


    Topic pages

    I feel dumb for not thinking of this sooner but we don't have to wait for the implementation of a fancy topic page. We can just make them using a regular sumo article (in the Navigation category so they don't show up in searches). In fact this might turn out to be perfectly workable and we'll never need to implement anything else.

    I mocked up a couple on the staging server:

    What do you think?

    We've had this [https://wiki.mozilla.org/Support/Kitsune/KB/context_scenarios/Ellen#Ellen:_Categories idea of article "Topics"] since we built the new KB last year but haven't really used it because they weren't localizable. Now they are and we're going to start using them. ==What do topics do?== *They allow us to automatically suggest a few [http://people.mozilla.org/~mverdi/screenshots/SUMO_-_How_do_I_use_the_Awesome_Screen%3F_%7C_How_to_%7C_Firefox_Help-20110803-104835.jpg related articles at the top of an article] and again at [http://people.mozilla.org/~mverdi/screenshots/SUMO_-_How_do_I_use_the_Awesome_Screen%3F_%7C_How_to_%7C_Firefox_Help-20110803-104951.jpg the bottom in the "Couldn't find what you were looking for?" section]. **We currently use just the "mobile" topic on mobile article and the related list is made up of other articles in the same category (how-to or troubleshooting) that also have the same tag. *They will also (soon) allow us to filter searches from the various start pages to articles with a particular topic. For example, the search on the [http://support.mozilla.com/mobile mobile start page] will only return documents with the "mobile" topic. **[http://people.mozilla.org/~mverdi/screenshots/relevant-to-20110803-110232.jpg We are going to simplify the "Relevant to" section of an article's description]. We'll have just 4 checkboxes: Desktop, Mobile, Sync and Firefox Home. Checking those will add the corresponding topic to the article. *All of the articles in a particular topic are listed on a special "Topic page." An early mockup looked like [http://moz.howsehold.org/sumo/kb/v3/03_topic+intro.png this] but the current implementation looks like [https://support.mozilla.com/kb/topic/mobile this] (more about this below). By linking these topic pages from the start pages we can give people browsing the site (versus searching) more ways to get to the content they are looking for. ==What topics should we use?== For search filtering (Relevant to) we'll use: *'''desktop''' *'''mobile''' *'''sync''' *'''FxHome''' These topics already exist and are look exactly like that. In addition, I'm proposing we create and use the following topics: *'''Video Tutorials''' - this would be for articles with a video that explains how to use a feature or accomplish a particular task (e.g. [[How to set the home page]] and [[Private Browsing]]). *'''Using Firefox''' - all articles (not just those with videos) that explain how to use a feature or accomplish a particular task (e.g. [[How do I use bookmarks?]]). *'''Customizing Firefox''' - articles about changing the way Firefox works or looks (e.g. [[How do I customize the toolbars?]] and [[Customizing Firefox with add-ons]]). *'''Privacy & Security''' - articles related to privacy or security features (e.g. [[How do I stop websites from tracking me?]] and [[Enabling and disabling cookies]]). *'''Solving Problems''' - more than just troubleshooting (to determine an issue and then fix it), these are articles that help people solve problems whether troubleshooting is involved or not (e.g. [[Add-ons are disabled after updating Firefox]] and [[Firefox does not ask to save tabs and windows on exit]]). *'''Reference''' - articles that mainly explain something about Firefox without showing you how to accomplish something (e.g. [[Options window - General panel]] and [[Profiles]]). '''Do you think there should be other topics or that any of these should be called something else?''' ==Topic pages== I feel dumb for not thinking of this sooner but we don't have to wait for the implementation of a fancy topic page. We can just make them using a regular sumo article (in the Navigation category so they don't show up in searches). In fact this might turn out to be perfectly workable and we'll never need to implement anything else. I mocked up a couple on the staging server: *[https://support.allizom.org/en-US/kb/video-tutorials Video Tutorials] *[https://support.allizom.org/en-US/kb/using-firefox Using Firefox] '''What do you think?'''
  2. What about a category for Features? Those articles that have as mission to explain what does the feature do and why you should use it. I'm thinking in articles like:

    - Use Tab Groups to organize a lot of tabs - Pinned Tabs - keep favorite websites open and just a click away - Bookmarks in Firefox - How do I set up Sync on my computer? - Pop-up blocker settings, exceptions and troubleshooting

    Perhaps it's a little bit too broad and we should exactly define the boundary between the articles that qualify and those that don't.

    Let me know if you need help collecting articles for topics.

    What about a category for Features? Those articles that have as mission to explain what does the feature do and why you should use it. I'm thinking in articles like: - [[What are Tab Groups?]] - [[What are App Tabs?]] - [[How do I use bookmarks?]] - [[What is Firefox Sync?]] - [[Pop-up blocker]] Perhaps it's a little bit too broad and we should exactly define the boundary between the articles that qualify and those that don't. Let me know if you need help collecting articles for topics.
  3. Ibai said

    What about a category for Features? Those articles that have as mission to explain what does the feature do and why you should use it.

    That would be the the Using Firefox topic.

    ''Ibai [[#post-41319|said]]'' <blockquote> What about a category for Features? Those articles that have as mission to explain what does the feature do and why you should use it. </blockquote> That would be the the '''Using Firefox''' topic.
  4. My 2 cents.

    Instead of, or in addition to, broad topics like "Using Firefox" and "Reference" (How to articles) or "Solving problems" (Troubleshooting articles) I would narrow it down to specific topics that explain better what the article is about, like MozillaZine does with its overlapping system of article categories, for example:

    • Websites
    • Profiles
    • Privacy and security
    • Bookmarks
    • Installation and updates
    • Customizing Firefox

    I don't know about "Video Tutorials" since that really doesn't define a topic and videos can be added to or removed from different articles as time passes.

    My 2 cents. Instead of, or in addition to, broad topics like "Using Firefox" and "Reference" ([/kb/category/20 How to articles]) or "Solving problems" ([/kb/category/10 Troubleshooting articles]) I would narrow it down to specific topics that explain better what the article is about, [http://kb.mozillazine.org/index.php?title=Special:Categories like MozillaZine does] with its overlapping system of article categories, for example: *Websites *Profiles *Privacy and security *Bookmarks *Installation and updates *Customizing Firefox I don't know about "Video Tutorials" since that really doesn't define a topic and videos can be added to or removed from different articles as time passes.

    Modified by AliceWyman on

  5. For topic pages used from the article explorer in the Firefox help homepage:

    • You need to have topics that fully cover the KB and, if possible, don't overlap each others.
    • These topic pages must be relevant to a product, so for instance you must have a Solving Problem page for Desktop, a one for Mobile, a one for Sync, and a one for FxHome.
    • If you want to create dedicated good looking topic pages instead of using existing ones, it will be very hard to maintain (see the Article Tracking example).
    • Video tutorials will be the only topic to overlap other topics and its page will be empty for almost every locales.


    For overlapping topics proposed by Alice, they could be used in the new search API.

    For topic pages used from the article explorer in the Firefox help homepage: * You need to have topics that fully cover the KB and, if possible, don't overlap each others. * These topic pages must be relevant to a product, so for instance you must have a Solving Problem page for Desktop, a one for Mobile, a one for Sync, and a one for FxHome. * If you want to create dedicated good looking topic pages instead of using existing ones, it will be very hard to maintain (see the [https://wiki.mozilla.org/Support/Article_Tracking Article Tracking] example). * Video tutorials will be the only topic to overlap other topics and its page will be empty for almost every locales. For overlapping topics proposed by Alice, they could be used in the [https://bugzilla.mozilla.org/show_bug.cgi?id=675693 new search API].
  6. The topics I was proposing are really centered around the front page. I think Alice's suggestions will help with the related article section. We don't have to show all topics on the front page but having a "Bookmarks" topic for example will make all of the five thousand bookmarks articles we have related to each other.

    scoobidiver said

    • These topic pages must be relevant to a product, so for instance you must have a Solving Problem page for Desktop, a one for Mobile, a one for Sync, and a one for FxHome.
    • If you want to create dedicated good looking topic pages instead of using existing ones, it will be very hard to maintain (see the Article Tracking example).

    Two things - We don't have to create a special topic pages for everything; the topic pages I'm talking about are little more than introductions (a video if it exists) and a link to the article.

    • Video tutorials will be the only topic to overlap other topics and its page will be empty for almost every locales.

    That's ok. It doesn't take much to set it up and will be helpful to a large number of people. If a locale doesn't want it, they can just remove the link to it.

    The topics I was proposing are really centered around the front page. I think Alice's suggestions will help with the related article section. We don't have to show all topics on the front page but having a "Bookmarks" topic for example will make all of the five thousand bookmarks articles we have related to each other. ''scoobidiver [[#post-41352|said]]'' <blockquote> * These topic pages must be relevant to a product, so for instance you must have a Solving Problem page for Desktop, a one for Mobile, a one for Sync, and a one for FxHome. * If you want to create dedicated good looking topic pages instead of using existing ones, it will be very hard to maintain (see the [https://wiki.mozilla.org/Support/Article_Tracking Article Tracking] example). </blockquote> Two things - We don't have to create a special topic pages for everything; the topic pages I'm talking about are little more than introductions (a video if it exists) and a link to the article. <blockquote> * Video tutorials will be the only topic to overlap other topics and its page will be empty for almost every locales. </blockquote> That's ok. It doesn't take much to set it up and will be helpful to a large number of people. If a locale doesn't want it, they can just remove the link to it.
  7. Related discussion: [/forums/knowledge-base-articles/707626]