Child pages
  • Knowledge Base Labels & Labeling Best Practices
Skip to end of metadata
Go to start of metadata

Labeling Conventions

Each article should have the following labels; articles without a correct Product+Page-Type label will not show up where they need to show up, so make sure to check that you're using the correct one! Other labels are important so that the articles show up in search results, and "related articles" sections.

  1. Product and Product Variations
    • Always label the page with the product which the content addresses, as well as any variations on the name. For example, Blackboard Learn would be labeled: 
      • blackboard
      • bb learn
      • bbl
  1. Page Type
    1. Always label with the page type, which should be listed below. If it isnt, ask yourself: "could this content be framed in a better way?"
      1. tutorial
      2. FAQ
      3. effective_practice
  2. Product+Page Type
    1. To ensure that the page gets linked in the right spots, ALWAYS include a label that combines the product page with the page type using an underscore (_), as shown below.
      1. Main Product Page: Blackboard Learn
        1. Example: bblearn_main

          If you want the product page to be a tile on the Knowledge Base Home Page, you need to include the label "tlpindex".

      2. Tutorial Page: product_tutorial
        1. Example: bblearn_tutorial
      3. FAQ Page: product_FAQ
        1. Example: kaltura_FAQ
      4. Effective Practice Page: product_ep
        1. Example: respondus_ep
      5. Issues & Bugs Page:
        1. Example: bblearn_bug
  3. User Intent/Search Tags
    1. Labels should reflect the content of the page and what it addresses, such as: video, test, upload, export, move, copy, share, hide, etc.
    2. Labels reflect the content of the page, but they should also reflect terms which the average knowledge base user would use to find the content. For example, a user searching for information on student preview mode might type in "student view". Unless we add the label "view" to the page, the only label in common is "student", which won't help them find what they need. In summary, you need to "translate" the correct terms to ones that people actually use