Diff for "DocTeam/ReviewProcess"

Not logged in - Log In / Register

Differences between revisions 3 and 4
Revision 3 as of 2008-02-07 17:10:36
Size: 2139
Comment: Simplified minor edit process, replaced "/Edit" with "/Draft"
Revision 4 as of 2008-06-17 14:21:18
Size: 2139
Editor: localhost
Comment: converted to 1.6 markup
No differences found!

Introduction

We have a simple review process for Launchpad help materials. Our two aims for the review process are to:

  • minimise bottlenecks
  • ensure Launchpad help materials are both accurate and easy to read.

If you produce or edit Launchpad help materials, please do take a few moments to get your work reviewed.

Minor edits in the Help wiki

Make your changes directly in the help wiki. If your change affects the way that people participate in Launchpad - e.g. you've changed a meeting time - please email the launchpad-users list to let them know.

Substantial Help wiki edits

  1. Before editing, copy the wiki page contents into an /Draft page: e.g. if you're editing the Feeds page, copy its unedited contents into Feeds/Draft.

  2. Save the unedited version in the /Draft page, to enable a reviewer to easily produce a diff between your draft and the original.

  3. Write "Draft copy" at the top of the page as a = header.

  4. Make your edits.
  5. Mail the launchpad-users list and cc matthew.revell@canonical.com with a link to your draft in /Draft. Start the email's subject with "Doc RFC:".

  6. Iteratively edit the document and republish the draft, following review comments on the mailing list.
  7. At least one other member of the team should declare the page ready for publication.
  8. Remove the draft warning, publish to the main page and then delete /Draft page.

New pages

  1. Create an /Draft page under the new page - e.g. /NewPage/Draft

  2. Write "Draft copy" at the top of the page as a = header.

  3. Make your edits.
  4. Mail the launchpad-users list and cc matthew.revell@canonical.com with a link to your draft in /Draft. Start the email's subject with "Doc RFC:".

  5. Iteratively edit the document and republish the draft, following review comments on the mailing list.
  6. At least one other member of the team should declare the page ready for publication.
  7. Remove the draft warning, publish to the main page and then delete /Draft page.

DocTeam/ReviewProcess (last edited 2008-06-17 14:21:18 by localhost)