HelpWikiQualityAssurance

Differences between revisions 14 and 15
Revision 14 as of 2006-11-25 20:48:49
Size: 4266
Editor: 85-210-195-200
Comment: removing Robert for now
Revision 15 as of 2007-04-30 10:24:21
Size: 4280
Editor: oak029b
Comment: Added myself to 'Interested'
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
 * '''Contributors''': MatthewEast, MatthewNuzum  * '''Contributors''': MatthewEast, MatthewNuzum, ["Philbull"]

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

  • Jane is looking for information about how to install a program. She finds a page contributed by a community member, but has no way of telling how reliable it is.
  • Bill has found a document about using a program, but doesn't know whether it is valid for the version of Ubuntu that he is using.
  • Jamie comes across a document which contains some information which doesn't work on his machine, and wants to report it to somebody.

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 - this page needs to be brought in line with the wiki's style guidelines for documentation

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

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

      4. Unsupported - this page may contain information which is not supported by the Ubuntu developers and may damage your system.

      5. Formatting - this page needs some work to improve its formatting

      6. Expansion - the content on this page is too brief and 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) [[Cleanup($category,$reason)]] where:

      • $category is one of the types identified above, and

      • $reason is a short explanation for including the page in cleanup

    • The macro should automatically show a box to the user at the top of the page which includes 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. Version applicability

    • Make it clear to the user what version of Ubuntu a particular document applies to.
    • Write a simple macro which responds to something like [[Version(5.10,6.06)]]. The macro should show a box to the user at the top of the page which explains which versions the document applies to.

  3. 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

Please feel free to add comments to the ["/talk"] page.


CategorySpec

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