HugDays
|
Size: 1411
Comment:
|
Size: 3419
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 [[https://help.ubuntu.com/community/CategoryCleanup |Categories to tags]]!''' |
| 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 by promoting and getting as many people involved as possible. |
| Line 13: | Line 11: |
| == Structure == | == Why == |
| 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. | 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 18: |
| === QA === | == Identifying Tasks == |
| Line 19: | Line 20: |
| QA Hug Days are to actively seek problems in the documentation, such as redundant pages, duplication and inaccurate information. | Topics will be added to this page and picked based on discussion through the DocumentationTeam mailing list. |
| Line 21: | Line 22: |
| Participants will locate bugs and tag them using the relevant tags. | 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. |
| Line 23: | Line 24: |
| === Repair === | * 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 25: | Line 29: |
| 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). | == When == |
| Line 27: | Line 31: |
| === Improvement === | Hug Days are initially monthly but might increase in frequency should there be both the level of participation and sufficient tasks. |
| Line 29: | Line 33: |
| Where areas of requested documentation are specifically targeted to be created or improved. | 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 33: | Line 48: |
| The promotion of Hug Days is essential, this section is to identify possible routes to our target audience. | 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. |
| Line 40: | Line 55: |
| * Ubuntu UK Podcast * Personal blogs * Documentation Team mailing list * Ubuntu Forums |
This month's Hug Day will focus on Categories to tags!
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 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)