Saturday, January 15, 2005

Hear, hear

annma writes:
I know the doc team is doing a tremendous job, what lacks is only outside involvement [...] Please, just write a few lines about your preferred program and send it to me, I'll include it in the manual!

The same goes for any other KDE apps, not just the kdeedu module: we'd really welcome the developers getting more involved with writing docs for their applications. Users too - if you notice something missing in the existing KDE docs, consider writing a bit. It doesn't need to be a full manual, and you don't have to commit to maintaining it. Most importantly,

You Don't Need to Learn Docbook!

Obviously, it's great if you have the time to learn it, but we'd rather have content in plain text, which we can add markup to, than no content at all.

If you're a user who'd like to help, drop an email along to kde-quality@kde.org, and they'll help you find an application which you'll enjoy working on, and give you some tips to get started.

If you're a developer, you could just take a look through the existing docs for your application and see what's missing or out-of-date there. If you don't have time to update the docs yourself, file a bug in the 'docs' product, with details of what's changed, or what's missing. It makes it a lot easier for us to update the documentation if we already know what needs to be done.

Lecture ends. :-)

0 Comments:

Post a Comment

<< Home