Support/Kitsune/KB/Priorities

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

P1

Site Wide

Presentation

  • The website and content is fully localizable. Verbatim for UI and SUMO for everything else. (ref)
  • SUMO detects what language is set and automatically directs a user to the correct localized version. (ref)
  • SUMO detects a users OS, Fx version, language and displays appropiate content, this can be set by the user. (ref)
    • 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.
  • Support for categories (e.g. KB article, Contrib doc, etc.), articles can only be in one category (e.g. for theming in later versions)
  • Support for tags (e.g. Bookmarks, Privacy, etc. Not free tagging)
  • Tags of articles included on start page. (ref) (+2-3 Days)
  • Start page and other special pages won't be wiki pages (e.g. start page)

Search

  • Only present articles that match users profile (OS/Firefox version)
  • The intro of an article should be included in the search results (this means not highlighting of matched search term)
  • Forum posts and KB articles are identified by separate icons

Navigation

  • Article tag pages (ref) (P1 is just an automatic listing of articles)
  • The secondary navigation (in the sidebar) depends on the status of the user (logged-in/out)

Administration

  • Articles in every category have a staging system and approval process
  • Add/remove media
  • Add/remove categories (needs to be discussed with webdev)
  • Add/remove tags (needs to be discussed with webdev)
  • edit username, avatar, etc (uses tikiwiki until 2.4)
  • remove user (uses tikiwiki until 2.4)
  • assign rights, groups (uses tikiwiki until 2.4)

Media Library

  • The medial library holds screenshots/videos to be included into articles (details like thumbnails and UI needs work)
    • This can work like Media Wiki but with the automatically generated thumbnails included in the file list view.

Messaging system

  • Localization dashboard includes a way to subscribe to email notifications of items waiting for review.
    • Email subject: (Title of Article) is ready for review (Username in parenthesis)
    • This works like the monitor this page links - it's a toggle. Click it again to unsubscribe from email notifications
  • Localization dashboard includes a way to subscribe to email notifications of all normal edits.
    • Email subject: (Title of Article) has been changed by (Username)
    • This works like the monitor this page links - it's a toggle. Click it again to unsubscribe from email notifications
  • review emails contain:
    • a nice, detailed html view of article diffs.
    • Username
    • time of edit
  • review emails contain links to approve or reject changes (like wordpress comment emails) - goes to a confirmation page.
  • All email subscriptions can be unsubscribed from a link in the email.

Article

URL structure

Presentation

  • Articles have tabs for different types of views
    • Not logged-in (Article, Discussion, Edit, Translate)
    • Logged-in: (Article, Discussion, Edit, Review Edit, Translate, Review Translation, History, Admin).
  • All articles have the same theme
  • Should degrade gracefully on IE at least for visitors. (ref)
  • Video plays in Theora using the built-in player (as a fallback video will play in the Flash player). (ref)
  • Articles have a print CSS (ref)
  • Single Poll per article
    • Data should be kept over time so we can look at votes in any given time period and not just total.
  • List of people who have contributed to the article

Editing

  • User must be logged in
  • Articles will be one blob of text
  • Articles support multiple titles - create a 2nd article and insert 1st as a subpage
  • Ability to mark an edit as ready for review. (ref)
  • Accurate full page preview of wiki edits, with working showfor and pictures (ref)
  • In the KB Edit view there should be an easy way to handle showfor tags (ref)
    • We can simplify the syntax to some extent. (need examples + info from James)
    • Showfor button in editor (needs discussion P2)
  • Ability to subscribe to email notifications of future edits/posts to the article. (ref)
  • You can toggle the Table of Contents on and off (ref)
  • You can add keywords to adjust search results
  • Access to a library of uploaded screenshots and screencasts (ref) (details TBD)
  • Editor buttons
    • Bold
    • Underline
    • Italics
    • Wiki Link
    • External Link
    • UL
    • OL
    • H1
    • H2
    • H3
    • Warning {{Warning|text}}
    • Note {{Note|text}}
    • Button (style) <btn>
    • File Path (style) <file>
    • Menu Path (style) <menu>
    • Keyboard button (style) {{Key|text}}
    • Insert Media
    • Insert Content (subpages list) [[Article:article name]]
    • Insert Menu path (subpages list)
    • Showfor (syntax TBD)
      • Showfor subpanel allows you to pick showfor properties (Win, Mac, Linux, Mameo, Android, Fx 3.6/3.5, Fx 4, Fx Mameo 1, Fx Android 1, etc.)
    • Wiki comment
  • Section for edit notes/comments
  • UI for adding and removing tags
  • UI for setting the article's category

Reviewing (English)

  • User must be logged in
  • Allow for side by side review. Workflow Diff ex)
  • When approving or rejecting an edit you should be able to send an email message to the author (the same way it's done now - not a PM).
  • Ability to mark edit as minor update - does not notify localizers, does not affect localization dashboard.
  • Ability to mark edit as normal (This is the default) (better name needed) - notifies localizers, edit appears on localization dashboard.
  • Ability to mark translations as out of date - notifies localizers, edit appears on localization dashboard, out of date warning added to the article page.
  • When any change is made a message should be sent to the author, admins and subscribers.

First Translation

  • User must be logged in
  • Allow for side by side translation (ref) (workflow)
    • Side-by-side view has English on left and begins with English on the right.
    • Right side of the side-by-side view has the wiki editing toolbar.
    • Side-by-side view also allows translating the article title.
  • When translating an article the local is automatically set to the one the user is using.
  • If someone tries to translate an article that only has a staging copy of the translation (not a approved version) they should be taken to that staging copy of the translation.
  • Area to describe/comment your edit
  • Ability to mark as ready for review

First Translation Review

  • User must be logged in
  • Same view as the First Translation except the translated section doesn't have an editor. Workflow
  • Side-by-side comparison of English and localized wiki markup
  • Ability to send a message to the editor
  • Ability to approve or reject

Update Translation

  • User must be logged in
  • Allow for side by side updating (ref) (workflow)
    • History selector included in this view (Needs discussion with James)
    • Side by side english diffs
    • Latest version of english article on the left side
    • Latest version of the translated article on the right side with wiki edit toolbar
  • Area to describe/comment your edit
  • Ability to mark as ready for review

Updated Translation Review

  • User must be logged in
  • English diffs with history picker (workflow)
  • Last to localized diffs
  • English version side by side with last localized version
  • Ability to send a message to the editor
  • Ability to approve or reject

Discussion

  • Every article has it's own discussion forum behind the discussion tab (ref) (2 weeks - copy of discussion forums - make it it's own KB app)
  • Users must be registered (ref)
  • Ability to log in or register in this view if you are not already. (ref)

Context

  • Automatic listing of related articles based on tags (ref)

History

  • Users who've edited an article
  • Pretty much an exact copy of the mediawiki diffs Diff ex

Administration

  • Assign to category
  • Assign tags
  • Delete articles




P3 - Sometime after launch

Site Wide

Presentation

  • Entire SUMO site works in/formatted for mobile browsers (ref) (3-4 weeks)

Administration

  • Add/remove groups
  • Add/remove contributors to groups
  • Edit group details
  • Add/Remove sidebar modules

Media Library

  • SUMO add-on: Takes videos dragged to the KB editor and compresses them in ogg and flash formats. It also grabs 5 frames from each video that can be used as a poster frame.

Contributors

  • Individual Dashboard - displays the stuff the contributor can act upon
    • Private messages
    • Review requests
  • Profile - displays information about the users for the world
    • Groups the user belongs to
    • avatar
    • personal info

Groups

  • Group Dashboard - Information that is useful for the group members, stuff they can act upon
    • Statistcs: Localized articles, Visitors this week, Visitors per article, Popular searchterms
    • Ability to sort KB articles by number of lines
    • Ability to sort KB articles by popularity
  • Group Profile - Information about the Group and it's member
    • Group leaders
    • How to contact the group
    • informative text about the group

Messaging system

  • Review emails contain link to contributor dashboard
  • Contributor group/team email/PM
  • Ability to reply to PM via email

Article

Presentation

  • Articles can have different display templates based on category (3 - 4 weeks). (ref) (ref) (ref)
  • All videos offer users sharing and embeding options. (ref)
  • Articles offer embed code - like Google Wave. (ref)
  • Step-by-step instructions have special presentation. You can click through each step.
    • Screenshots and Screencasts presented with the applicable step-by-step text instruction below. There is navigation included that allows the user to move back and forward though the steps, let's them know where they are in the process and allows them to skip directly to any step. (ref) (ref) (example) (example)
  • When a user mouses over highlighted sections of the screenshots they are shown notes with extra information about the interface, functions and features. (ref) (example)
  • Articles can have an Advanced view/expandable div that presents additional information. (ref)
  • Includes that the times are configurable for locales. So it should not say Mai 5 2010, 14:30 PDT in German, but 5. Mai 2010, 23:30 MEZ
  • Dates displaye in Time zone
  • Category landing page can display articles prominently, video tutorials and complete a listing of the other articles available. (ref) (ref)
  • The site offers contextual help where necessary. (ref)
  • Articles should be exportable. So that localizers can use the content on their portals
  • Multiple polls per article (about +2 weeks)

Editing

  • Rich Text editor (ref)
  • Auto-save
  • The KB editor allows for drag and drop uploading of images and videos to the media library (ref)
  • Drag and drop and uploading supports multiple files.
  • Support for adding outlines and notes to screenshots. (ref)(ref) (example)
  • Interface for adding step-by-step instructions (ref)

Reviewing

  • Ability to mark a rejected edit as spam, so the user is deleted, any images they uploaded are deleted, and no notifications are sent to the user about the rejection.

Translation

  • Ability to mark a translation as in progress to lock out/notify other translators

Discussion

  • Replies can be posted via email by replying to the notification in your email program. (ref)
  • A new thread in the articles forum creates a new article (and vice versa)
  • Article threads automatically link to the staging copy of the article

Context

  • Ability to create custom content blocks on an article by article basis (2-3 weeks for widgetized sidebar)
    • Featured article listings on article pages that include embeded video, images and text. (ref)
    • Embeded videos grow to full size when played (example) (ref)
  • Ability to manually edit automatic related article recommendations (3-4days)
    • Manually added entries would be listed first; automatic entries listed second.

History / Statistics

  • popularity (views)
    • ranking
  • CSAT over time
  • helpfulness over time, overlaid with edits over time
  • message when helpfulness goes down significantly after edit