Diff for "DocTeam/UserGuide"

Not logged in - Log In / Register
Differences between revisions 1 and 2
⇤ ← Revision 1 as of 2008-02-11 15:33:20 →
Size: 2525
Editor: 77-100-239-119
Comment:
← Revision 2 as of 2008-02-11 16:51:07 → ⇥
Size: 3286
Editor: 77-100-239-119
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Between now and June, we're going to write a new Launchpad user guide. This will replace just about everything that we have on the Help wiki at the start of the process.

The aims of this rewrite are:

 * Highlight and explain every part of Launchpad.
 * Provide a coherent tutorial, the individual pages/sections of which stand alone.

We have a [:DocTeam/StyleGuide/UserGuideTemplate:template for user guide pages] and a [:StyleGuide:style guide] to help make the help wiki consistent.
Line 4: Line 12:
 * Each section will have a ToC that won't form part of the tutorial's flow.
 * Primary articles are part of the tutorial's flow. Secondary are not but are linked from the section ToC and where necessary.		 Each section of the tutorial will have its own directory on their help wiki: ```/Teams/``` for example.
Line 7: Line 14:
The wiki home page will link to the contents/overview page of each of these sections.

Each page of the tutorial will link to the previous and next pages.

= Style =

Primary articles are part of the tutorial's flow: i.e. they are linked using the ```next``` and ```previous``` links. Secondary are not but are linked from the section ToC and where necessary.

Between now and June, we're going to write a new Launchpad user guide. This will replace just about everything that we have on the Help wiki at the start of the process.

The aims of this rewrite are:

  • Highlight and explain every part of Launchpad.
  • Provide a coherent tutorial, the individual pages/sections of which stand alone.

We have a [:DocTeam/StyleGuide/UserGuideTemplate:template for user guide pages] and a [:StyleGuide:style guide] to help make the help wiki consistent.

Structure

Each section of the tutorial will have its own directory on their help wiki: /Teams/ for example.

The wiki home page will link to the contents/overview page of each of these sections.

Each page of the tutorial will link to the previous and next pages.

Style

Primary articles are part of the tutorial's flow: i.e. they are linked using the next and previous links. Secondary are not but are linked from the section ToC and where necessary.

/

YourAccount

Primary articles:

Secondary articles:

Nice to have:

Teams

Primary articles:

  • Teams/Joining
  • Teams/CreatingAndRuning
  • Teams/MailingLists
  • Teams/Polls
  • Teams/Mentoring

Projects

Primary articles:

  • Projects/Registering
  • Projects/ReleasesSeriesMilestones
  • Projects/FileDownloads
  • Feeds/ProjectAnnouncements

Bugs

Primary articles:

  • Bugs/Reporting
  • Bugs/YourProjectsBugs
  • Bugs/MultiProjectBugs
  • Bugs/ExternalWatches
  • Bugs/Statuses
  • Bugs/Expiry
  • Bugs/EmailInterface
  • Bugs/BugBranchLinks

Code

Primary articles:

  • Code/HostingBazaarBranches
  • Code/BranchingFromLaunchpad
  • Code/TeamBranches
  • Code/BranchesHostedElsewhere
  • Code/ImportingCVSAndSvn

Translations

Primary articles:

  • Translations/TranslatingSoftware
  • Translations/Teams
  • Translations/TranslatingYourProject
  • Translations/Exports

Blueprint

Primary articles:

  • Blueprint/TrackingWork
  • Blueprint/Meetings

Answers

Primary articles:

  • Answers/AskingForHelp
  • Answers/ProvidingHelp
  • Answers/CreatingAndUsingFAQs
  • Answers/OfferingHelpForYourProject

PPAs

Primary articles:

  • PPA/BuildingAndHostingPackages
  • PPA/CommonErrors
  • PPA/FAQs

/GetInvolved

Primary articles:

Others

Deletion candidates

Pages that have no obvious replacement in the new user guide and that are better explained elsewhere.

DocTeam/UserGuide (last edited 2010-11-11 19:50:27 by 122-63-10-108)