[kde-doc-english]new and looking to help

Lauri Watts lauri at kde.org
Mon Dec 16 09:49:27 CET 2002


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Saturday 14 December 2002 00:44, Matt Jones wrote:
> I am looking to help with the writing of the documentation.  I am not sure
> where to sart actually, but I was looking to do KIT.  KIT needs to be
> updated so I am not quite sure how to go about that.
>

Well, you've already done one of the hardest parts, picking an application 
that you'd like to work on, and asking how to start!

Normally you need to be running the CVS version of KDE, or at least the 
application you plan to work on, however, Kit is quite stable and doesn't 
change much, you should be quite safe to begin working using the current 
released version, but I do encourage you to update to at least KDE 3.1 as 
soon as possible after it's release, and at least consider switching to CVS 
when KDE 3.2 is close to ready.

You should contact the developer (in this case, Neil Stevens) who will be more 
than happy to hear you are interested, and will help you all he can.  There's 
nobody who can answer questions about an application as well as the person 
who wrote it. I've cc'ed him on this email, so he knows you're out there 
ready to work.

The next step is - write!

We use DocBook XML, and Kit's existing documentation is already well marked 
up. There are resources at http://i18n.kde.org/doc/ to help you get going, 
and I highly encourage you to learn the markup, it's not really as 
intimidating as it looks.  

Use the existing documentation as a guide, and ask for as much help as you 
need, right here on the list, we'll be glad to teach you.  Don't, however, 
let the markup intimidate you into not writing, or let it hold you up too 
much initially.  

Whether you write in plain text, or have a go at the markup yourself, send me 
a copy of your work when you have done some (early and often is good when 
you're learning) and when we're all happy with it, I'll commit it to CVS for 
you.  

Right now new documentation will be aimed at the KDE 3.2 release, which is 
quite a long time away, so there isn't any deadline pressure yet.  

Welcome aboard!

Regards,
- -- -- 
Lauri Watts
KDE Documentation: http://i18n.kde.org/doc/
KDE on FreeBSD: http://freebsd.kde.org/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (FreeBSD)

iD8DBQE9/ZOX/gUyA7PWnacRAt9HAJ9rjCvN08xH2Sr/AZk4oXAwMFwQkgCgizcR
NziUMy2oiLGt7lz8np5t25I=
=0fmQ
-----END PGP SIGNATURE-----




More information about the kde-doc-english mailing list