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
- URLS look like: https://support.mozilla.com/en-US/kb/1234/How_do_I_set_the_homepage
- This lets you edit the title as you edit the article without loss of information.
- 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?
- Start page
Previous P1 document, with links
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) (P2 discuss with James - what is this based on? Tags?
- 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 seperate icons
- 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
- Add/remove media
- Add/remove categories (needs to be discussed with webdev)
- Add/remove tags (needs to be discussed with webdev)
Article
URL structure
- DB number is used to identify article
- Follow by sanitized version of article title. e.g. https://support.mozilla.com/en-US/kb/1234/How_do_I_set_the_homepage
- When editing an article, the DB number is used. e.g. https://support.mozilla.com/foo.php?Article=1234
- Wiki links work like they currently do:
- Localized article titles displayed
- No local specified in the url so user is automatically sent to the localized version (if it exists).
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
- List of people who have contributed to the article
Editing
- 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
- Note
- Button (style)
- File Path (style)
- Menu Path (style)
- Keyboard button (style)
- Insert Media
- Insert Content (subpages list)
- Insert Menu path (subpages list)
- Showfor
- 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
- Allow for side by side review. (needs clarification. Similar to Translation Review 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.
Translation
- User need to 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
Update Translation
- User need to 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
Translation Review
- User need to be logged in
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 wikipedia
Administration
- Assign to category
- Assign tags
- Delete articles
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.
- 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.
Administration
Things the administrator can do with the user account Using current tikiwiki system
- edit username, avatar, etc
- remove user
- assign rights, groups
P3 - Doesn't need to happen right away
- Embeded videos grow to full size when played - related to custom content blocks (example) (ref)
- Step-by-step instructions have special presentation. You can click through each step. (ref)
- Search results clearly identify KB article results and Forum post results. (ref) (2-3 weeks)
Presentation
- 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
- Articles listed by categories on front page. (ref)
Administration
- Add/remove groups
- Add/remove articles
- Add/Remove sidebar modules
Article
- WYSIWYG / Rich Text editor (ref)
- Auto-save
- The KB editor allows for drag and drop uploading of images (ref)
- Drag and drop uploading of screencasts. (ref)
- Drag and drop and uploading supports multiple files.
- The editor includes tools for adding outlines and notes to screenshots. (ref)(ref) (example)
- Each section is resizable and contains it's own rich text toolbar (ref)
- The article sections can be drag and dropped into a new order like a netflix queue (ref)
- There is a rich text 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.
Discussion
- Replies can be posted via email by replying to the notification in your email program. (ref)
Statistics
- popularity (views)
- ranking
- CSAT over time
- helpfulness over time, layed over with edits over time
Presentation
- Articles can have different display templates. (ref) (ref) (ref)
- All videos offer users sharing and embeding options. (ref)
- Articles offer embed code - like Google Wave. (ref)
- Screenshots 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)
- 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)
- 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) (example) (example)
- Articles can have an Advanced view that presents additional information not normally seen. (ref)
Context
- Ability to create custom content blocks on an article by article basis
- Featured article listings on article pages that include embeded video, images and text. (ref)
Administration
- [P3] Ability to create custom content blocks (2-3 weeks for widgetized sidebar)
- [No] Add/remove SHOWFOR labels/tags/detection
- [No] Add/remove locales
- [2.4] Add/remove users
- [P3] Assign themes to pages
Translation
- [P3]Ability to mark a translation as in progress to lock out/notify other translators
Discussion
- [No - needs email confirmation] When registration is complete, the user is logged in and taken to their original destination. (ref)
Administration
- [no] Ability for admins to add javascript and/or html to a wiki page in order to add functionality to an article, i.e. Personas. (ref)
- [P3] Multiple polls per article (about +2 weeks)
Presentation
- [P3] (3-4 weeks) Entire SUMO site works in/formatted for mobile browsers (ref)
- [P3] ability to manually edit automatic related article recommendations (3-4days)
Administration
- [P3] More than one theme for articles (3 - 4 weeks)
Article
Individual contributors (whole section from requirements is P2)
Dashboard
The dashboard displays the stuff the contributor can act upon
- Private messages
- Review requests
Profile
The profile displays information about the users for the world
- teams the user belongs to
- avatar
- personal info
Messaging system
- review emails contain link to contributor dashboard
- Contributor group/team email/PM
- Ability to reply to PM via email
Contributor Groups
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
Profile
Information about the Group and it's member
- Group leaders
- How to contact the group
- informative text about the group
Administration
Things administrators can do with groups
- assign members
- remove
- edit group details
to be categorized
- 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.
- 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