KubuntuDocs

Differences between revisions 1 and 24 (spanning 23 versions)
Revision 1 as of 2005-10-18 03:09:15
Size: 790
Editor: 69-87-140-197
Comment: creating page for UbuntuBelowZero/BOF
Revision 24 as of 2006-04-03 12:54:34
Size: 2976
Editor: mail
Comment: minor updates to this spec
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
 * Created: [[Date()]] by JonathanJesse
 * Priority: NeedsPriority
 * People: NeedsLead, NeedsSecond
 * Contributors: JonathanJesse
 * Interested: JonathanJesse
 * Status: UbzSpecification, BrainDump (then DraftSpecification then EditedSpecification then ApprovedSpecification), DistroSpecification
 * Branch: KubuntuTrack
 * Malone bug:
 * Packages affected:
 * Depends:
 * Dependents:
 [[FullSearch()]]
 * BoF sessions: none yet
 * People: JonathanJesse, JonathanRiddell
Line 18: Line 6:
How will Kubuntu Docs work for DapperDrake and following releases
D
ocuments we will be focusing on for DapperDrake
Line 22: Line 11:
The documents for BreezyBadger where thrown together at the last minute. Some of the Kubuntu doc team 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 work to finish. We should not repeat this in Dapper as it is going to be supported for 5 years.
Line 23: Line 14:

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 Desktop Guide to find out.
Line 26: Line 21:
Documentation for Kubuntu Dapper, i.e. creating documents for the desktop.

We will use Ubuntu's documentation for the server and non-desktop parts.
Line 27: Line 26:

The goal is for 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 30: Line 37:
The Release Notes 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.

JonathanJesse 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 32: Line 47:
=== 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 and PackagingGuide.
Line 34: Line 49:
== 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

Rationale

The documents for BreezyBadger where thrown together at the last minute. Some of the Kubuntu doc team 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 work 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 Desktop Guide to find out.

Scope

Documentation for Kubuntu Dapper, i.e. creating documents for the desktop.

We will use Ubuntu's documentation for the server and non-desktop parts.

Design

The goal is for 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 Notes 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.

JonathanJesse 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 and PackagingGuide.

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.