HelpWikiQualityAssurance

Differences between revisions 8 and 9
Revision 8 as of 2006-07-13 15:50:31
Size: 3265
Editor: mailgate
Comment: trivial
Revision 9 as of 2006-07-13 15:59:49
Size: 3224
Editor: mailgate
Comment: minor reorganisation
Deletions are marked like this. Additions are marked like this.
Line 32: Line 32:
 1. '''Feedback'''
  * Make it easy for users to give feedback on the wiki by expanding the use of talk pages and developing a comment box with which users can easily submit comments.

== Implementation ==

 1. '''Cleanup'''
Line 48: Line 42:
  * Make it easy for users to give feedback on the wiki by expanding the use of talk pages and developing a comment box with which users can easily submit comments.
Line 51: Line 46:

== Implementation ==

Summary

This spec aims at introducing features to the documentation wiki (https://help.ubuntu.com/community) to allow greater quality assurance and to inform users about the reliability of the pages they are reading.

Rationale

The documentation wiki is increasingly important for the development of documentation and in the future might conceivably be the only place that documentation for the Ubuntu project develops. It is also freely editable by anyone. As a result, quality assurance and social control is of vital importance. It is also important that the user gets a good impression of how reliable a particular document is when reading it.

Use cases

Scope

The documentation wiki at https://help.ubuntu.com/community

Design

  1. Cleanup

    • See discussion [http://thread.gmane.org/gmane.comp.web.wiki.moin.general/3975/focus=3975 on the MoinMoin mailing list]. A solution may be:

    • Establish some concrete categories of cleanup that different pages require. Not too many, but enough to encapsulate what we need. For example:
      1. Style - the page needs to be brought in line with the wiki's style guidelines for documentation

      2. Review - the page needs to be reviewed by the documentation team

      3. Update - the page needs to be updated to include information about the latest version of Ubuntu

      4. Formatting - the page needs to be better presented

      5. Expansion - the content on the page needs expanding

      Look at [http://en.wikipedia.org/wiki/Wikipedia:Cleanup the different categories that Wikipedia uses] and learn from them.

    • Write a macro which responds to (something similar to) the following code.

      [[Cleanup(style)]]
      [[Cleanup(review)]]
      [[Cleanup(update)]]
      [[Cleanup(formatting)]]
      [[Cleanup(expansion)]]
    • The macro should show a box to the user at the top of the page which explains the reason that the page has been tagged with Cleanup, how to help and how to discuss the issue with the documentation team.
    • Make this macro easy to add to pages via a drop-down menu (not essential)

      We can then generate lists of pages which have been tagged with this macro by doing a [[FullSearch]] on the macro text.

  2. Feedback

    • Make it easy for users to give feedback on the wiki by expanding the use of talk pages and developing a comment box with which users can easily submit comments.
    • Figure out how to add a link to the header which takes the user to the talk page of the page they are looking at
    • The user should not have to create that page (problematic?)
    • The talk page should automatically contain the [[PageComment2]] macro, which would do nicely for inserting comments ([http://moinmoin.wikiwikiweb.de/MacroMarket/PageComment2 homepage]).

Implementation

Code

Unresolved issues

BoF agenda and discussion


CategorySpec

HelpWikiQualityAssurance (last edited 2008-08-06 16:37:07 by localhost)