Proposal for CategoryReview

Jeff Schering jeffschering at gmail.com
Wed Jul 12 17:39:05 UTC 2006


Here is a proposed process for getting pages reviewed and then put
into CategoryCleanup if required. It is a sort of "peer review"
process.

Pages get into CategoryReview in one of two ways:

1. After the author has finished working on a new page, he or she puts
it into CategoryReview. A reviewer looks it over and decides whether
or not it should go into CategoryCleanup.

2. The page has been in CategoryCleanup for more than six months or
for at least 3 months into the next release.

One of the problems with CategoryReview is that authors may not put
the page into it, or that someone might be a bit too proactive and
stick it into CategoryReview before the author has finished. Perhaps
CategoryReview boilerplate text can be put into the standard template.

Other problems are these: Who are the reviewers? What are the criteria
for inclusion in CategoryCleanup? Is this just a bureacratic hoop for
wiki authors to jump through?

In any case, here's a proposed text that would be at the top of each
document placed into CategoryReview:

------------------------------------------------------
This document is in the process of being reviewed for technical
accuracy, or might be out of date. It might also have problems with
grammar, spelling and style.

This document was first created on: (insert date here)
------------------------------------------------------

And this is a proposed text that would be at the top of each document
placed into CategoryCleanup:

------------------------------------------------------
To meet the quality standards for Community Docs, this article or
section requires additional work.

Text specific to the problem goes here. Problems can be grammar and
spelling, technical, style, or whatever. Include links to appropriate
help sections on the wiki.

When the changes have been made, please return this page to
CategoryReview. You can discuss this issue on the either the IRC
channel #ubuntu-doc or on the mailing list.

This page was placed into CategoryCleanup by (name here) on (date here)
------------------------------------------------------

The purpose of inserting the dates and names is to bring a bit of
accountability to the process. Pages that are in CategoryReview for a
long time will make us look bad and therefore will encourage us to
keep a close eye on things.

Cheers,
Jeff

-- 
Jeff Schering
GPG: F23C67E8




More information about the ubuntu-doc mailing list