Support/Kitsune/KB/Priorities-cheng

From MozillaWiki
< Support‎ | Kitsune‎ | KB
Jump to: navigation, search

P1

This is now organized by feature to be more readable.

Articles

  • Articles are stored as a single blob of text
  • Articles can be included inside other articles by way of "subarticle" markup.
    • This will allow us to have articles with different titles be the same base article.
  • Articles are in categories that relate to article function: How to contribute vs Knowledge base vs Admin (Do we need an admin category)
    • Different categories of articles may have different templates
  • Articles in every category have a staging system and approval process
  • Articles have tags that describe the article contents. "mobile" vs "desktop" vs "Firefox 3" vs "bookmarks" are all tags.
    • We may have articles grouped by tag on the front page
    • Need "tag pages" which list articles with a certain tag
  • Articles have keywords (alternate search terms) which are words and phrases that cause the article to show up in search results but aren't in the article body. Things like "favorites", "urlbar"
  • Articles are referenced by a number/unique ID which isn't the page title
  • Related pages are shown in the sidebar
    • Automatically generated list based on tags
    • Customizable list per article to be placed above autogenerated list.
  • Article store edit history with diffs for comparison
    • Needs some mockup and clarification

Showing customized content (SHOWFOR and others)

  • Searches only show articles tagged with relevant tags (ie if the user is on OSX, only articles with osx tag show up)
  • Searches detect language and show localized content. Articles direct to the right place.
  • Offer a way for a user to change this and store this preference site wide.
  • For visitors using another browser, default to latest Firefox end-user release.
  • OS should be detectable regardless of browser, but if it cannot be detected, default to Windows.

Markup/Editing

  • Based on mediawiki
  • Markup for table of contents so they can be removed
  • Showfor markup should be easier to use and make sense
  • All article features (tags, categories, keywords) listed above need UI for entering/editing/removing given associated permissions.

Editor

  • Buttons for bold, italics, common markup Need full list
  • Preview should be complete and accurate (with ability to see windows/osx content)
  • Way to mark an edit as now requiring review rather than just saving it.
    • Eg: this edit is in-progress, don't review yet vs now please review -- email gets sent out.

Review Process

  • Show a side-by-side diff during review
    • Need clarification of exactly what is needed
  • Can attach message when approving/rejecting which will be added to email notification
  • 3 levels of edits: minor (typos), major (no factual changes) and needs re-translation of other locales

Localization

  • Website strings should be localizable
  • Articles should be localizable
  • Localized articles are linked to their English translations
  • Side-by-side localization UI for articles
    • To do: mock this up clearly.

Templates

  • Templates need to degrade gracefully in IE
  • We need better print stylesheets that hide sidebars.
  • Sidebar navigation is context specific to your logged-in state.

Search

  • Article search results show intro rather than context for found words.

Polls

  • One poll per article initially
    • Should be able to add multiple polls via markup in the future
  • Data should be kept over time so we can look at votes in any given time period and not just total.

Media

  • Support both screenshots and screencasts
  • Media is uploaded to a central media library
    • Need to iron out workflow here
    • Administrators can add/remove media from this interface
      • (What should happen if an image is already in an article?)
  • UI is needed for inserting images during editing
    • Need workflow/wireframes here to figure out how this would work
  • Screencasts are Theora with flash fallback

Discussion

  • New App to handle article discussion that doesn't overlap with existing forums
  • Mostly a copy-paste of existing discussion forums
  • One forum created per article, multiple threads possible per article.
  • Needs associated notification system (may need to tie in with article notification system we should decide sensible defaults)
  • Needs exact workflow, can we have tabs, if not how do we link contribs from article to discussion and back

Notifications

  • Contributors can sign up for emails for edits to specific articles and include HTML diffs
  • Emails for review requests include links to approve/reject but take to an "Are you sure" page.
  • Emails are sent to watchers when edits are approved/rejected
  • By default authors and editors are notified
  • Can sign up for notifications on a category-wide or locale-wide basis.

Special pages

  • The following pages need to be designed separately:
    • Start page
      • We should have space in the UI for messaging urgent things (like "Upgrade Flash!") without breaking layout or requiring a push
    • Media library
    • Live Chat start page?
    • What else?