<div dir="ltr">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: <a href="https://wiki.ubuntu.com/AshiqAlMoosani">https://wiki.ubuntu.com/AshiqAlMoosani</a> Regards, Ashiq <div class="gmail_quote">2009/9/8 Matthew East <<a href="mailto:mdke@ubuntu.com">mdke@ubuntu.com</a>> <blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"> Hi Ashiq, <div><div></div><div class="h5"> On Sat, Sep 5, 2009 at 10:30 PM, Ashiq Al-Moosani<<a href="mailto:ashiq.almoosani@gmail.com">ashiq.almoosani@gmail.com</a>> 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 > <a href="https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/Tasks" target="_blank">https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/Tasks</a>. I am > new at this and any guidance is appreciated. </div></div>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: <a href="https://wiki.ubuntu.com/AugustinaBlair/MakeUsbStartupDraft" target="_blank">https://wiki.ubuntu.com/AugustinaBlair/MakeUsbStartupDraft</a> 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 <a href="https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation" target="_blank">https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation</a>. 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 <a href="http://www.mdke.org" target="_blank">http://www.mdke.org</a> gnupg pub 1024D/0E6B06FF </blockquote></div> </div>