Support:Search Requirements: Difference between revisions
No edit summary |
(reorganize) |
||
Line 1: | Line 1: | ||
THIS DOCUMENT IS A DRAFT OF OUR SEARCH ENGINE REQUIREMENTS FOR SUMO. IT IS NOT YET FINAL. | 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 [https://bugzilla.mozilla.org/show_bug.cgi?id=398353]). 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 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") | |||
==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) |
Revision as of 00:38, 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 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")
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)