[Kst] Documentation

[Philip Rodrigues]

Hi all,
I've been contracted by George to work on the Kst documentation. I'm just 
starting out, and finding my way around, so I'm looking for some feedback 
about what I should be working on.

I took a look through the existing docs, which appear to be extremely good, 
and very comprehensive. I thought of a few (fairly minor) things on which I 
could spend some time, so I'd like your opinions on whether they're 
needed/desired:

Screenshot format: For official KDE documentation, we've standardized the 
screenshots to the Plastik widget style and window decoration. The existing 
Kst screenshots aren't in this style. Is it a priority for anyone that they 
be changed?

Formulae: Just a technical query: How are the PNG's of formulae generated? 
They look like LaTeX to me, but I'm not sure of the easiest way to get PNG 
output from LaTeX for individual formulae. Could someone point me in the 
right direction?

Manpage: Since Kst has a command-line 'mode', it might be appropriate to have 
a manpage. The necessary content appears to exist in the docs, it's just a 
case of making it into manpage format (hopefully autogenerated).

Index: Adding an index using DocBook is fairly easy, and hopefully makes it 
easier for users to find the particular information they're looking for. Any 
thoughts?

Technical level: This is perhaps the one on which I would most value your 
input. The current level of the Kst docs appears to assume a fairly high 
level of technical knowledge on the part of the reader. As I understand it, 
the current user base is research scientists, so this is appropriate. Is it 
intended or desired that the docs reduce their technical level, or should 
they stay as they are in this respect?

Intro/Overview of the doc: I'd like to add an introductory section with a 
brief overview of what the documentation contains, to help users find the 
appropriate section. Any thoughts?

Examples: The discussion in the existing docs is often quite abstract. Would 
it be useful (I think it would) to add some practical examples (eg, "Making a 
color map" or "Generating a power spectrum") that walk through some common 
tasks in Kst?

Hopefully some of those suggestions are useful ones that I can pursue. If you 
have any questions, comments or thoughts, please do get back to me.

Looking forward to working with you all,
Regards,
Philip

-- 
KDE Documentation Team: http://i18n.kde.org/doc
KDE Documentation Online: http://docs.kde.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : http://mail.kde.org/pipermail/kst/attachments/20041220/9616fc5b/attachment.pgp