HelpWikiQualityAssurance

Revision 1 as of 2006-07-13 15:00:30

Clear message

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

Use cases

Scope

Design

  • Establish some concrete categories of cleanup that different pages require. 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

Implementation

  • 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)

Code

Data preservation and migration

Unresolved issues

BoF agenda and discussion

CategorySpec