Confirmed users
447
edits
Support/Kitsune/Features/Auto-Nav: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
|||
| Line 1: | Line 1: | ||
== Purpose == | == Purpose == | ||
To automate the creation of navigation pages based on our existing Information Architecture. This will | To automate the creation of navigation pages based on our existing Information Architecture. This will reduce overall maintenance, L10n requirements, and manual work. It will also improve scalabilty, laying the foundation for Kitsune to grow in a structured and maintainable way. | ||
== Outcome == | == Outcome == | ||
Articles that are newly created or modified will automatically appear on the appropriate landing pages based on the topics, categories, and products assigned to them. | |||
If the new IA is wanted, non-en locales will mirror the en-US IA as soon as the articles and tags have been translated. There will be minimal L10n requirements for setting up navigation beyond the main landing page and localizing strings. | |||
==Open issues/risks== | ==Open issues/risks== | ||
* Development cost vs Benefit | |||
* Abuse of tags - Creating extra navigation topics either accidently or maliciously | |||
* How is product picker sourced? | |||
* How is topic picker sourced? | |||
* Images for topics | |||
* Sort order for topics | |||
* Sort order for products | |||
* Sort order for articles returned | |||
* How do we manage exceptions? What do we do when we DON'T want it done automatically. | |||
* How do we enable on a locale by locale basis | |||
* How do assign products to all existing articles? | |||
* Migrating current tags to controlled vocabulary | |||
* In-Product link articles will always show at the top of lists based on page views | |||
==Definition== | ==Definition== | ||
===Feature overview=== | ===Feature overview=== | ||
* Every article is assigned a product, topic, and category. | |||
* Topic pages, Product pages, and article listing pages will be populated automatically based on these tags. | |||
* Article listing pages have topic navigation based on facets | |||
* Articles will also contain topic navigation based on facets | |||
===Users & use cases=== | ===Users & use cases=== | ||
Firefox users browsing for help. Should be able to narrow down the overall pool of support articles by making a series of selections. The experience feels familiar, like navigating through folders, but is actually faceting our support articles. | |||
Users who have come to SUMO from a 3rd party site. They will be able to quickly and accurately navigate to a more appropriate article. | |||
SUMO authors will be able to create content quickly and put it in the best location for visibility just by tagging the article correctly. | |||
===Dependencies=== | ===Dependencies=== | ||
* Faceted search backend implementation | |||
* Tailored Search | |||
* Ability to create and manage a controlled vocabulary of tags | |||
===Requirements=== | ===Requirements=== | ||
Admin: | |||
* A user interface to create the controlled vocabulary for tags. This must be kept locked down to prevent abuse. | |||
* Each Product and Topic created in the interface may need an | |||
** image | |||
** description | |||
** Display order | |||
** Display name | |||
* A list of available topics per product. Topics can be shared on these lists between products. | |||
* Specify a default sort order for all articles | |||
* A tool to specify a unique sort order for any Product/Topic combination | |||
* If you select "Custom" for the sort order you can specify an existing wiki page that the sytem will use to generate the list of articles. | |||
Authoring: | |||
* A unique field for Product, Topic, and Category | |||
* You must select a Product before you select a Topic | |||
* The list of Topics will be generated based on the list of Topics per product (See Admin section). | |||
* These fields will be required. You must select at least one item from each of these groups, but you can select more than one item from both Product and Topic. | |||
* A field to assign an image to an article that will be displayed in article listing pages. This is NOT a required field. | |||
Navigation: | |||
Main SUMO Page: | |||
* Look at all Product tags in the system. Display them in the Product section of the main SUMO page in the order specified in the admin panel. | |||
* Look at all Topic tags in the system. Display them in the Topic section of the main SUMO page in the order specified in the admin panel. | |||
You've Selected a Product: | |||
* Look at the Product that has been selected. Of all articles assigned to that product, we will generate a list of which topics are also assigned to this content. | |||
* List the topics generated in the previous step in the order specified in the Admin panel | |||
You've slected a Topic: | |||
* Look at the Topic that has been selected. Of all articles assigned to that product, establish which Products are also tagged to those articles. | |||
* Display the list of Products in the order specified in the admin panel | |||
You've selected a Topic and a Product - Article Listing page: | |||
* Look at the Product and the Topic selected previously. Generate a list of ariticles that match BOTH of these tags. | |||
* Look at our sort order list in the admin panel. If the Topic/Product combination is in the list, we will display the articles in the order specified. If no exception has been made, we will display this list of articles in the defaul sort order. | |||
===Non-Goals=== | ===Non-Goals=== | ||