[prev in list] [next in list] [prev in thread] [next in thread] 

List:       quanta-devel
Subject:    Re: [quanta-devel] Quanta Documentation: English
From:       Andras Mantia <amantia () kde ! org>
Date:       2007-02-02 15:49:21
Message-ID: 200702021749.21344.amantia () kde ! org
[Download RAW message or body]

[Attachment #2 (multipart/signed)]


Hi,

On Saturday 27 January 2007, Mr. Jellynek wrote:
> as one who wishes to contribute to the revisions of, and or authoring
> new documentation for Quanta +, I invite you to propose to me any 1.)
> sections of existing documentation which you feel needs improving,

Hopefully the users will react to this. ;-)

> 2.) topics / issues / features of Quanta + which are either not
> emphasized in the existing documentation, or perhaps not covered
> throroughly enough to meet your expectations or needs, or 

You know, if I'd remember all the features, probably they would be 
mentioned in the documentation. So I can't say what is missing there 
right now. Probably the PHP debugger documentation is lacking. There 
are tutorials linked from the Quanta+ website 
(http://quanta.kdewebdev.org/docs.php), but they might be slightly out 
of date and well, they cause some problems for me as well to follow. I 
don't have anything to the authors, actually I'm glad that they wrote 
it, but some weeks ago I needed the debugger, and sincerely I got 
confused about what I should really do and how it works. ;-)
AFAIK using XDebug instead of Gubed is not described at all.

> 3.) cite 
> any routine development tasks / project procedures / or general
> Quanta-as-Tool-for-Efficiency-- the very IDE nature of Quanta +, vs
> "You as Developer" (or the Design / Dev community at large) which, if
> included in the "Getting Started with Quanta +" pages might greatly
> improve a new user's experience with the Software, boost their
> learning curve, and ultimately encourage their own further
> exploration.
>
> i'm enthusiastic about becoming involved in editing / authoring some
> of the Quanta + "docbook", but I must admit that it is difficult to
> find a "starting place". Not difficult to find "something", or
> "anything", but to find something which i feel comfortable in
> devoting my enthusiasm without the though "gee, is this even going to
> help?"

The "Getting Started" is a good start. ;-) It should contain something 
like what is Quanta good for, examples how to use as editing a simple 
HTML file, how to set up projects and work with them, how to use 
different languages and XML variants, and things like that. Many of 
this information is already in the docbook, so the getting started part 
might just refer to those sections. Of course those section might be 
reworked/reworded if needed.
The best would be to think from the user point of view. I'm a developer, 
I know the software, but from a different point. What I may consider 
not so important to describe, might be important for the user. So try 
to imagine that you just installed Quanta and what would you want to do 
with it. And document those steps that are needed to achieve what you 
want.
 To see what I'm talking about: the current documentation is rather a 
simple describing of different functions and features and not exatly a 
help how to use them efficiently.

> hopefully, enjoyable to read. so, i've got some "stuff", but i do
> welcome your input.

I have to check your other mails, maybe you already sent some "stuff", 
but if not, the best is to send. Also as we are only a few developers, 
with other things to do as well, if you don't get replies for some 
time, it might just mean, that you can go ahead as you think its the 
best. This is rather natural with open source projects, especially 
KDE. ;-) Do not worry, if somebody doesn't like something be sure that 
sooner than later that somebody will raise his voice!

> PS. i'm far from the being the "master of Quanta+", or a master
> programmer, but i do have a decent skill for proofreading, and
> grammar, etc (when needed ;)

That's good, as I'm not a native speaker...

> , so if i'm missing the public cry 
> already, let me knw-- point me to a URL. Maybe someone has a Wiki
> already for this "wish-list" stuff?

There is no specific Quanta wiki, only the generic KDE wiki 
(wiki.kde.org), which has some Quanta stuff, but sincerely I do not 
follow it.

Andras

-- 
Quanta Plus developer - http://quanta.kdewebdev.org
K Desktop Environment - http://www.kde.org

[Attachment #5 (application/pgp-signature)]

_______________________________________________
quanta-devel mailing list
quanta-devel@kde.org
https://mail.kde.org/mailman/listinfo/quanta-devel


[prev in list] [next in list] [prev in thread] [next in thread]