KubuntuDocs

Differences between revisions 19 and 20
Revision 19 as of 2005-11-04 13:58:28
Size: 3051
Editor: 221_220_103_66-WIFI_HOTSPOTS
Comment: Review, minor wording fixes
Revision 20 as of 2005-11-04 14:47:33
Size: 2942
Editor: 205_220_103_66-WIFI_HOTSPOTS
Comment:
Deletions are marked like this. Additions are marked like this.
Line 21: Line 21:
Documentation for Kubuntu Dapper.

{{{XXX:smurf: *All* of Kubuntu Dapper? Including all the games and all the server stuff? Probably not...
An earlier version of this document stated "Not so much on server docs", which makes sense here.}}}
Documentation for Kubuntu Dapper. Creating documents for the desktop, using Ubuntu's documentation for server and non-desktop parts.

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 User Guide to find out.

Scope

Documentation for Kubuntu Dapper. Creating documents for the desktop, using Ubuntu's documentation for 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 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.