KubuntuDocs

Differences between revisions 15 and 16
Revision 15 as of 2005-11-01 16:21:39
Size: 2718
Editor: 69-87-140-60
Comment:
Revision 16 as of 2005-11-04 00:36:07
Size: 3135
Editor: 209
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
 * Created: [[Date()]] by JonathanJesse
 * Priority: NeedsPriority
Line 6: Line 4:
 * Contributors: JonathanJesse
 * Interested: JonathanJesse, JeromeGotangco, PatrickDavies
 * Status: UbzSpecification, BrainDump (then DraftSpecification then EditedSpecification then ApprovedSpecification), DistroSpecification
 * Branch: KubuntuTrack
 * Malone bug:
 * Packages affected:
 * Depends:
 * Dependents:
 [[FullSearch()]]
 * BoF sessions: none yet
Line 18: Line 6:
What documents will we be focusing on for DapperDrake?
D
ocuments we will be focusing on for DapperDrake
Line 25: Line 14:
Line 26: Line 16:

Line 31: Line 19:
Maisie wants to know what's new in Kubuntu Dapper, she looks up the quick guide to find out.

Konqi wants to know the Kubuntu way of using MSN Messenger, he looks up the Kubuntu User Guide to find out.
Line 32: Line 24:
Goal is three important documents to updated and finished. The Kubuntu FAQ Guide, Kubuntu Release Notes, and the User Guide should be finished before release. Also any updates and changes to the docs during the 5 year support window should be packaged and updatable via Adept or apt-get.
Documentation for Kubuntu Dapper.
Line 35: Line 29:
Goal is three important documents to be updated and finished. The Kubuntu Desktop Guide will take over from the currently incomplete FAQGuide and Kubuntu User Guide. The Kubuntu Quick Tour will be a friendly guide to Kubuntu with screenshots and short descriptions. The Kubuntu Release Notes should be merged into the website/e-mail Release Announcement as in Breezy there is a lot of duplication here.
Line 36: Line 32:
As I worked w/ JonathanRiddell on the Kubuntu Release Notes for BreezyBadger, I would like to focus on the release notes for DapperDrake. We need to work with RobertStoffers to make any changes to the FAQGuide that are Kubuntu Specific whether thru profiling or creation of new doc.
The Kubuntu User Guide is currently a work in progress and needs to be finished. Current status can be found at DocteamProjects. Screenshots and information will need to be changed and updated to reflect Dapper.
Line 39: Line 33:
TroyWilliams will be working on Adept User Manual to replace his Kynaptic User Guide that he wrote for BreezyBadger. (See AdeptGuide for specs) The release announcement will be used in e-mail and website announcements for the pre-releases and final release.
Line 41: Line 35:
We will need to figure out who will be packaging these docs and uploading them. Can we set Kubuntu-Docs up so the same person who does Ubuntu-Docs can do the same basic steps for Kubuntu-docs? See also https://launchpad.net/distros/ubuntu/+spec/inclusion-of-docs The Quick Tour will be a one page document to show the new and best features in Kubuntu Dapper, the emphasis will be on a quick read so the features can be appreciated at a glance.

The Kubuntu User Guide is currently a work in progress. There is also an unofficial Kubuntu FAQ (http://kudos.berlios.de/). These should be used as a primer for the new Kubuntu Desktop Guide which will mirror the Ubuntu Desktop Guide (see DocteamPlansDapper). Rather than a list of applications available in Kubuntu the Desktop Guide will show the user how to perform common tasks such as installing a program or adding a new user. Around half the User Guide document is currently written, we should preserve this where it fits in to the Desktop Guide. Screenshots and information will need to be changed and updated to reflect Dapper.

TroyWilliams will be working on an Adept User Manual to replace his Kynaptic User Guide that he wrote for BreezyBadger, see AdeptGuide for the spec. The Adept Guide will be included in KDE's SVN to accompany Adept.
Line 44: Line 43:
=== Data preservation and migration === We will use the same source packaging as the Ubuntu docs, keeping a separate binary package for kubuntu-docs. We will also ship Ubuntu docs where they apply to Kubuntu such as ServerGuide.
Line 46: Line 45:
== Outstanding issues ==

== BoF agenda and discussion ==
We will also use the same translation infrastructure as the Ubuntu docs. This will require us to keep to the string freeze for Ubuntu's release schedule.

Summary

Documents we will be focusing on for DapperDrake

  • Let's finish the Kubuntu Starter Guide and incorporate it to the milestones
  • Also check on the content of KDE docs, maybe some of the stuff needed for a User Guide are already there and just needs a few edits and screenshots.
  • Not so much on server docs

Rationale

The documents for BreezyBadger where thrown together at the last minute. There was not a real plan and part of it was my fault. Some of us were working on docs that are now scheduled for Dapper, instead of things that were going to get released in Breezy. The About Kubuntu and Kubuntu Release Notes took a lot of last minute stuff to finish. We should not repeat this in Dapper as it is going to be supported for 5 years.

Use cases

Maisie wants to know what's new in Kubuntu Dapper, she looks up the quick guide to find out.

Konqi wants to know the Kubuntu way of using MSN Messenger, he looks up the Kubuntu User Guide to find out.

Scope

Documentation for Kubuntu Dapper.

Design

Goal is three important documents to be updated and finished. The Kubuntu Desktop Guide will take over from the currently incomplete FAQGuide and Kubuntu User Guide. The Kubuntu Quick Tour will be a friendly guide to Kubuntu with screenshots and short descriptions. The Kubuntu Release Notes should be merged into the website/e-mail Release Announcement as in Breezy there is a lot of duplication here.

Implementation

The release announcement will be used in e-mail and website announcements for the pre-releases and final release.

The Quick Tour will be a one page document to show the new and best features in Kubuntu Dapper, the emphasis will be on a quick read so the features can be appreciated at a glance.

The Kubuntu User Guide is currently a work in progress. There is also an unofficial Kubuntu FAQ (http://kudos.berlios.de/). These should be used as a primer for the new Kubuntu Desktop Guide which will mirror the Ubuntu Desktop Guide (see DocteamPlansDapper). Rather than a list of applications available in Kubuntu the Desktop Guide will show the user how to perform common tasks such as installing a program or adding a new user. Around half the User Guide document is currently written, we should preserve this where it fits in to the Desktop Guide. Screenshots and information will need to be changed and updated to reflect Dapper.

TroyWilliams will be working on an Adept User Manual to replace his Kynaptic User Guide that he wrote for BreezyBadger, see AdeptGuide for the spec. The Adept Guide will be included in KDE's SVN to accompany Adept.

Code

We will use the same source packaging as the Ubuntu docs, keeping a separate binary package for kubuntu-docs. We will also ship Ubuntu docs where they apply to Kubuntu such as ServerGuide.

We will also use the same translation infrastructure as the Ubuntu docs. This will require us to keep to the string freeze for Ubuntu's release schedule.