Support:Search Requirements: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(reorganize)
No edit summary
Line 20: Line 20:
===Ranking===
===Ranking===
Be able to weigh articles
Be able to weigh articles
* Based on relevance?
* Based on their source (KB articles rank higher than forum threads)
* Based on relevance
* Based on their tags?
* Based on their tags?
* Based on their poll results?
* Based on their poll results?
Line 38: Line 39:
*Synonyms (searching for "favorites" also searches for "bookmarks")
*Synonyms (searching for "favorites" also searches for "bookmarks")
*Ignores locale-specific common words ("the", "a", "Firefox")
*Ignores locale-specific common words ("the", "a", "Firefox")
*Handle partial matches, where most but not all terms are in the article.





Revision as of 00:59, 13 May 2008

THIS DOCUMENT IS A DRAFT OF OUR SEARCH ENGINE REQUIREMENTS FOR SUMO. IT IS NOT YET FINAL.

Results

Source data

Results coming from KB and from forum. (Only forum topics that are marked as answered?)

Only show articles from the Knowledge Base category, not administrative, staging, or sandbox articles.

Should only look at the content, title, and tags of the article and not other features of the page.

"Notice" new or changed content within 24 hours.

Handle tiki formatting correctly (search for "code" should not return all pages that use the code tag)

Localization

The locale should be detected (and possible to override) like articles. Only the selected/detected locale should be searched. However, many locales will have incomplete translations, which means it would also list content not localized (using the same locale fallback mechanism as defined in [1]). In summary, a search should return all results for the current locale + any remaining articles in the fallback locales, but it should never list the same article twice, even if it exists for two locales.


Ranking

Be able to weigh articles

  • Based on their source (KB articles rank higher than forum threads)
  • Based on relevance
  • Based on their tags?
  • Based on their poll results?
  • Based on their page hit count?

Every article should only appear once (a single article can be at multiple URLs because of redirects and page parameters).


Performance

Doesn't bring things to a grinding halt. (Quantify)


Fudge factor

  • Handle spelling errors ("did you mean...").
  • Synonyms (searching for "favorites" also searches for "bookmarks")
  • Ignores locale-specific common words ("the", "a", "Firefox")
  • Handle partial matches, where most but not all terms are in the article.


Display

  • Show the title of the page, the first paragraph, and maybe the text surrounding the text matched.
  • Display results as plain text without Tiki formatting
  • Show data on the article?
    • Popularity
    • Poll results
  • "More like this"?
    • I personally don't see the benefit (djst)