HugDays

Differences between revisions 2 and 3
Revision 2 as of 2009-05-08 20:39:21
Size: 2193
Editor: host86-155-26-65
Comment:
Revision 3 as of 2009-05-08 20:53:33
Size: 2755
Editor: host86-155-26-65
Comment:
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
This week's Hug Day will focus on '''<<<TARGET>>>'''!

Brief instructions.
'''This month's Hug Day will focus on <<<TARGET>>>'''!
Line 11: Line 9:
The DocumentationTeam is proposing a monthly Hug Day to improve and maintain our material, whilst bolstering community involvement in the team and to foster good relationships with other teams. The DocumentationTeam runs a monthly Hug Day - a day to concentrate on a specified area of the documentation, whilst bolstering community involvement..
Line 15: Line 13:
There will be three types of Hug Day - QA, Repair and Improvement. These are envisaged as primarily focusing on the Community Documentation Wiki. There will be three types of Hug Day - QA, Repair and Improvement. These are envisaged as primarily focusing on the Community Documentation Wiki but could be implemented with system documentation too. 
Line 17: Line 15:
=== QA ===

QA
Hug Days are to actively seek problems in the documentation, such as redundant pages, duplication and inaccurate information.

Participants will locate bugs and tag them using the relevant [[https://help.ubuntu.com/community/Tag | tags]].

=== Repair ===
QA Hug Days are to actively seek problems in the documentation, such as redundant pages, duplication and inaccurate information. Participants will locate bugs and tag them using the relevant [[https://help.ubuntu.com/community/Tag | tags]].
Line 27: Line 19:
=== Improvement === Where areas of requested documentation are specifically targeted to be created or improved.
Line 29: Line 21:
Where areas of requested documentation are specifically targeted to be created or improved. == Organisation ==

Documentation Team presence and availability on IRC is important, as there are likely to be more questions during hug days.

It would also help to identify potential problems and likely questions to form a FAQ and pre-empt questions and minimise team workload.

Documentation Team are of course free to contribute but their focus should be guidance.
Line 40: Line 38:
 * Ubuntu UK Podcast
Line 41: Line 40:
== Suggestions == Initially establishing a high visibility for this initiative is essential for it to succeed.

== Suggesting and picking topics ==

Topics will be added to his page and picked based on discussion through the DocumentationTeam mailing list.
Line 45: Line 48:
 * Categories to tags - [[https://help.ubuntu.com/community/CategoryCleanup | These]] topics are in need of cleanup but they are labelled using category rather than a tag. Each page needs ''CategoryCleanup'' removed from the bottom of the page and a suitable tag added to clarify why it needs cleanup. --DougieRichardson  * Categories to tags - [[https://help.ubuntu.com/community/CategoryCleanup | These]] topics are in need of cleanup but they are labelled using category rather than a tag. Each page needs Category''''''Cleanup removed from the bottom of the page and a suitable tag added to clarify why it needs cleanup. --DougieRichardson

This month's Hug Day will focus on <<<TARGET>>>!

Documentation Hug Days

The DocumentationTeam runs a monthly Hug Day - a day to concentrate on a specified area of the documentation, whilst bolstering community involvement..

Structure

There will be three types of Hug Day - QA, Repair and Improvement. These are envisaged as primarily focusing on the Community Documentation Wiki but could be implemented with system documentation too.

QA Hug Days are to actively seek problems in the documentation, such as redundant pages, duplication and inaccurate information. Participants will locate bugs and tag them using the relevant tags.

Repair Hug Days address issues found on QA Hug Days or other issues identified by the team (such as clean up or converting categories to tags).

Where areas of requested documentation are specifically targeted to be created or improved.

Organisation

Documentation Team presence and availability on IRC is important, as there are likely to be more questions during hug days.

It would also help to identify potential problems and likely questions to form a FAQ and pre-empt questions and minimise team workload.

Documentation Team are of course free to contribute but their focus should be guidance.

Promotion

The promotion of Hug Days is essential, this section is to identify possible routes to our target audience.

  • Planet Ubuntu
  • LWN
  • Fridge
  • Ubuntu Weekly News
  • Prominent positioning on HUC
  • Ubuntu UK Podcast

Initially establishing a high visibility for this initiative is essential for it to succeed.

Suggesting and picking topics

Topics will be added to his page and picked based on discussion through the DocumentationTeam mailing list.

This is a list of suggested hug day topics and can be added to by anyone. Please add your name to your suggestion so that we can seek clarification if needed.

  • Categories to tags - These topics are in need of cleanup but they are labelled using category rather than a tag. Each page needs CategoryCleanup removed from the bottom of the page and a suitable tag added to clarify why it needs cleanup. --DougieRichardson

  • Wiki to Community - A lot of pages that are on the team Wiki should be on the community wiki. This page lists those which should be moved and how to do it. --DougieRichardson


CategoryDocteam

DocumentationTeam/Ideas/HugDays (last edited 2011-05-26 21:29:48 by 85-210-11-2)