HugDays
|
Size: 2764
Comment:
|
← Revision 12 as of 2011-05-26 21:29:48 ⇥
Size: 3418
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## page was renamed from DocumentationTeam/HugDays | |
| Line 5: | Line 6: |
| '''This month's Hug Day will focus on <<<TARGET>>>'''! |
|
| Line 9: | Line 8: |
| The DocumentationTeam runs a monthly Hug Day - a day to concentrate on a specified area of the documentation, whilst bolstering community involvement.. | '''NOTE: Documentation Hug Days are not currently operating.''' |
| Line 11: | Line 10: |
| == Abstract == | The DocumentationTeam runs a monthly Hug Day - a day to concentrate on a specified area of the documentation, whilst bolstering community involvement by promoting and getting as many people involved as possible. |
| Line 13: | Line 12: |
| There are three types of Hug Day - QA, Repair and Improvement. | == Why == |
| Line 15: | Line 14: |
| QA Hug Days are to actively seek problems in the documentation, such as redundant pages, duplication and inaccurate information. | Documentation, the Community Wiki in particular, often has areas which require attention. These tasks fall into one of three categories: * QA - redundant pages, duplication and inaccurate information. * Structure - addressing changes to the structure of a site, such as migrating Wiki to Community. * Expansion - expanding existing areas specifically identified in requests from Brainstorm. |
| Line 17: | Line 19: |
| 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). | == Identifying Tasks == |
| Line 19: | Line 21: |
| Improvement days will focus on developing new pages on specifically requested topics. This is envisaged to coincide with the proposed usage of brainstorm. | Topics will be added to this 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 - [[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 * Wiki to Community - A lot of pages that are on the team Wiki should be on the community wiki. [[https://wiki.ubuntu.com/CategoryDocumentation | This page]] lists those which should be moved and how to do it. --DougieRichardson * System Documentation - Search for problems in the help documents, like identifying bad information, areas of missing information, typos, bad links, and so on. -- [[LaunchpadHome:rocket2dmn]] <<DateTime(2009-05-09T18:46:31-0500)>> * Strive to complete these tasks before DocumentationStringFreeze |
| Line 23: | Line 32: |
| It would be best if we could nominate a particular date each month to provide consistency and make it easier to develop promotional or marketing material for this initiative. For example the first Saturday of the month. | Hug Days are initially monthly but might increase in frequency should there be both the level of participation and sufficient tasks. It would be ideal to have a specific date, such as the first Saturday of the month say, in order to simplify marketing. I suggest we look at availability within the team and discuss the best day. == The Documentation Team's Role == Documentation Team's members role would primarily be: * Being available on IRC to answer questions. * Ensuring that the Style Guide is followed. * Arbitrating disputes. Members should be available throughout the day in #ubuntu-doc on irc.freenode.net any questions can be asked there. Members are asked to note what times are convenient for them and add their availability to this page, the more the merrier but as long as we can cover the whole period. |
| Line 38: | Line 60: |
== Asking questions == The Documentation Team's members will be available throughout the day in #ubuntu-doc on irc.freenode.net any questions can be asked there. Members are asked to note what times are convenient for them and add their availability to this page. == 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 - [[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 * Wiki to Community - A lot of pages that are on the team Wiki should be on the community wiki. [[https://wiki.ubuntu.com/CategoryDocumentation | This page]] lists those which should be moved and how to do it. --DougieRichardson |
Documentation Hug Days
NOTE: Documentation Hug Days are not currently operating.
The DocumentationTeam runs a monthly Hug Day - a day to concentrate on a specified area of the documentation, whilst bolstering community involvement by promoting and getting as many people involved as possible.
Why
Documentation, the Community Wiki in particular, often has areas which require attention. These tasks fall into one of three categories:
- QA - redundant pages, duplication and inaccurate information.
- Structure - addressing changes to the structure of a site, such as migrating Wiki to Community.
- Expansion - expanding existing areas specifically identified in requests from Brainstorm.
Identifying Tasks
Topics will be added to this 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
System Documentation - Search for problems in the help documents, like identifying bad information, areas of missing information, typos, bad links, and so on. -- rocket2dmn 2009-05-09 23:46:31
Strive to complete these tasks before DocumentationStringFreeze
When
Hug Days are initially monthly but might increase in frequency should there be both the level of participation and sufficient tasks.
It would be ideal to have a specific date, such as the first Saturday of the month say, in order to simplify marketing.
I suggest we look at availability within the team and discuss the best day.
The Documentation Team's Role
Documentation Team's members role would primarily be:
- Being available on IRC to answer questions.
- Ensuring that the Style Guide is followed.
- Arbitrating disputes.
Members should be available throughout the day in #ubuntu-doc on irc.freenode.net any questions can be asked there. Members are asked to note what times are convenient for them and add their availability to this page, the more the merrier but as long as we can cover the whole period.
Promotion
The promotion of Hug Days is essential, this section is to identify possible routes to our target audience. Initially establishing a high visibility for this initiative is essential for it to succeed.
- Planet Ubuntu
- LWN
- Fridge
- Ubuntu Weekly News
- Prominent positioning on HUC
- Ubuntu UK Podcast
- Personal blogs
- Documentation Team mailing list
- Ubuntu Forums
DocumentationTeam/Ideas/HugDays (last edited 2011-05-26 21:29:48 by 85-210-11-2)