Update the documentation for computer-janitor-gtk package

[Ashiq Al-Moosani]

Hi Matthew and docteam,

I would appreciate it if you could review and give me your feedback on my
proposed outline of the documentation for computer-janitor-gtk. I have
created the outline here:
https://wiki.ubuntu.com/AshiqAlMoosani

Regards,
Ashiq

2009/9/8 Matthew East <mdke at ubuntu.com>

> Hi Ashiq,
>
> On Sat, Sep 5, 2009 at 10:30 PM, Ashiq
> Al-Moosani<ashiq.almoosani at gmail.com> wrote:
> > Hello, I would like to register my interest in helping to update the
> > documentation of the computer-janitor-gtk package. This is with ref. to
> the
> > item in the 'Ubuntu tasks' table at
> > https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/Tasks. I
> am
> > new at this and any guidance is appreciated.
>
> Hi there, and welcome to the documentation team. You've picked a
> challenging task, but very valuable one and any contribution you can
> make to this would be very much appreciated. Given that the task
> involves writing a new document from scratch (there isn't any
> documentation for the program yet, except for the man page), here is
> what I'd suggest doing (others may also have suggestions):
>
> 1. Familiarise yourself with the computer-janitor-gtk program. Play
> around with it (preferably the latest development version in Karmic).
> Read the man page.
>
> 2. Sketch out a structure for the document on a wiki page. Have a look
> at the help for some other Gnome applications and see how they are
> structured. Take a look at the way Augustina approached the task of
> writing a document for the usb-creator program here:
> https://wiki.ubuntu.com/AugustinaBlair/MakeUsbStartupDraft and try and
> do something similar to the "goal", "scenarios" and "proposed outline"
> sections in that page. Then post your ideas here on the mailing list
> and we can discuss them and give some feedback.
>
> 3. Start writing! I think that given that you are new to the team, the
> best approach is to start writing on a wiki page, as Augustina has
> done. Then you can post again here for feedback and discussion on the
> text.
>
> 4. Turn the text into docbook. For this it will be necessary to get to
> know our tools a bit. You can find out all about them at
> https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation.
>
> If any of the steps get a bit daunting, we will be around to help. You
> don't have to complete then on your own!
>
> Once that has been done, we can figure out where to put the document
> in the ubuntu-docs package and the task is complete.
>
> I'm copying Lars Wirzenius into this thread, as he is the author of
> the computer-janitor program and will also be able to provide some
> feedback as the task proceeds.
>
> Let us know if you have any questions.
>
> --
> Matthew East
> http://www.mdke.org
> gnupg pub 1024D/0E6B06FF
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20090914/7d15af09/attachment.html>