HelpWikiQualityAssurance

Differences between revisions 1 and 2
⇤ ← Revision 1 as of 2006-07-13 15:00:30 →
Size: 1716
Editor: mailgate
Comment: creating page
← Revision 2 as of 2006-07-13 15:04:14 → ⇥
Size: 2430
Editor: mailgate
Comment: expanded a bit
Deletions are marked like this. Additions are marked like this.
Line 13: Line 13:
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.
Line 16: Line 18:

The documentation wiki at https://help.ubuntu.com/community
Line 37: Line 41:
We can then generate lists of pages which have been tagged with this macro by doing a {{{[[FullSearch]]}}} on the macro text.
Line 38: Line 44:

Should be pretty easy - could be based on a simple macro like {{{[[BR]]}}} or {{{[[Include]]}}}

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

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

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

Code

Should be pretty easy - could be based on a simple macro like [[BR]] or [[Include]]

Data preservation and migration

Unresolved issues

BoF agenda and discussion

CategorySpec

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