Diff for "DocTeam"

Not logged in - Log In / Register

Differences between revisions 9 and 11 (spanning 2 versions)
Revision 9 as of 2008-06-17 14:21:20
Size: 1501
Editor: localhost
Comment: converted to 1.6 markup
Revision 11 as of 2008-08-18 13:28:36
Size: 2464
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
= What we do = = Overview =
Line 4: Line 4:
'''Our main project:''' we're creating a brand new user guide for Launchpad! See more at: The Launchpad Documentation Team is a community team that helps ensure there's accurate help material about Launchpad, including:
Line 6: Line 6:
 * [[DocTeam/UserGuide|Page outlines]] of the new user guide.
 * [[DocTeam/Specs|Blueprints]] covering each section of the new user guide, with milestone targets.
 * the Launchpad user guide and help wiki
 * Launchpad user interface text
 * the [[https://launchpad.net/+tour|Launchpad tour]].
Line 9: Line 10:
Come and join the [[https://launchpad.net/~launchpad-doc|Launchpad Documentation team]] if you want to help: You can help by:
Line 11: Line 12:
 * produce and review new help materials for Launchpad
 * review and report [[https://edge.launchpad.net/launchpad-documentation|bugs against existing user interface text and help materials]]
 * promote Launchpad to others through testimonials, screen casts, case studies and articles.
 * filing bugs about Launchpad help materials: useful if there's a mistake you don't have access to fix or you feel there's a page or section missing from the help wiki
 * correcting obvious mistakes: you can fix typos etc on most help wiki pages
 * creating draft pages: if you want to suggest major changes or the content for brand new pages, create a draft on the help wiki - e.g. ```DocTeam/Draft```
Line 15: Line 16:
= Joining = == Marking pages that need work ==
Line 17: Line 18:
If you're interested, there are a couple of things you should take a look at: If you report a bug against a particular page in the help wiki, please link the page to the bug report.
Line 19: Line 20:
For example:

||<tablestyle="width: 100%; background-color: #ededed;">'''[[https://bugs.launchpad.net/bugs/258483|Bug 258483]] is about this page.'''||

If a page hasn't been touched in a while and needs work, please get in touch with one of the [[https://launchpad.net/~launchpad|Launchpad team]] and ask them to put this banner on that page:

||<tablestyle="width: 100%; background-color: #ededed;">'''This page needs your help!''' Can you help ensure the information on this page is accurate? If so, please make the changes directly in the page.||

= Joining the team =

If you want to use the Launchpad documentation mailing list and also register your interest in helping to shape the future of Launchpad's help materials, [[https://launchpad.net/~launchpad-doc|join the team]] in Launchpad.

= What we're working on =

You can see what help materials the Launchpad team and the community Launchpad documentation team are working on by viewing milestones associated with the [[https://launchpad.net/launchpad-documentation|Launchpad Documentation project]].

= Our materials =

 * [[DocTeam/UserGuide|What we're planning for the Launchpad user guide]]
Line 20: Line 40:
 * our [[DocTeam/ReviewProcess|review process]]
 * the [[https://edge.launchpad.net/launchpad-documentation|Launchpad Documentation project]].
Line 23: Line 41:
If you haven't already, you should sign up for the [[http://lists.ubuntu.com/mailman/listinfo/launchpad-users|launchpad-users]] mailing list. The team is brand new, right now, and we'll have our first team meeting soon. In the mean time, join us in the ```#launchpad``` channel on Freenode. If you haven't already, you should sign up for the [[http://lists.ubuntu.com/mailman/listinfo/launchpad-users|launchpad-users]] mailing list.

Overview

The Launchpad Documentation Team is a community team that helps ensure there's accurate help material about Launchpad, including:

  • the Launchpad user guide and help wiki
  • Launchpad user interface text
  • the Launchpad tour.

You can help by:

  • filing bugs about Launchpad help materials: useful if there's a mistake you don't have access to fix or you feel there's a page or section missing from the help wiki
  • correcting obvious mistakes: you can fix typos etc on most help wiki pages
  • creating draft pages: if you want to suggest major changes or the content for brand new pages, create a draft on the help wiki - e.g. DocTeam/Draft

Marking pages that need work

If you report a bug against a particular page in the help wiki, please link the page to the bug report.

For example:

Bug 258483 is about this page.

If a page hasn't been touched in a while and needs work, please get in touch with one of the Launchpad team and ask them to put this banner on that page:

This page needs your help! Can you help ensure the information on this page is accurate? If so, please make the changes directly in the page.

Joining the team

If you want to use the Launchpad documentation mailing list and also register your interest in helping to shape the future of Launchpad's help materials, join the team in Launchpad.

What we're working on

You can see what help materials the Launchpad team and the community Launchpad documentation team are working on by viewing milestones associated with the Launchpad Documentation project.

Our materials

If you haven't already, you should sign up for the launchpad-users mailing list.

Who to speak to

If you've got any questions, ping mrevell in #launchpad or mail feedback@launchpad.net

DocTeam (last edited 2021-05-27 14:22:16 by cjwatson)