From quanta-devel Fri Feb 02 15:49:21 2007 From: Andras Mantia Date: Fri, 02 Feb 2007 15:49:21 +0000 To: quanta-devel Subject: Re: [quanta-devel] Quanta Documentation: English Message-Id: <200702021749.21344.amantia () kde ! org> X-MARC-Message: https://marc.info/?l=quanta-devel&m=117043139810764 MIME-Version: 1 Content-Type: multipart/mixed; boundary="--===============0801604121==" --===============0801604121== Content-Type: multipart/signed; boundary="nextPart1900694.6VnUq5g2Qu"; protocol="application/pgp-signature"; micalg=pgp-sha1 Content-Transfer-Encoding: 7bit --nextPart1900694.6VnUq5g2Qu Content-Type: text/plain; charset="iso-8859-2" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline 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=20 You know, if I'd remember all the features, probably they would be=20 mentioned in the documentation. So I can't say what is missing there=20 right now. Probably the PHP debugger documentation is lacking. There=20 are tutorials linked from the Quanta+ website=20 (http://quanta.kdewebdev.org/docs.php), but they might be slightly out=20 of date and well, they cause some problems for me as well to follow. I=20 don't have anything to the authors, actually I'm glad that they wrote=20 it, but some weeks ago I needed the debugger, and sincerely I got=20 confused about what I should really do and how it works. ;-) AFAIK using XDebug instead of Gubed is not described at all. > 3.) cite=20 > 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=20 like what is Quanta good for, examples how to use as editing a simple=20 HTML file, how to set up projects and work with them, how to use=20 different languages and XML variants, and things like that. Many of=20 this information is already in the docbook, so the getting started part=20 might just refer to those sections. Of course those section might be=20 reworked/reworded if needed. The best would be to think from the user point of view. I'm a developer,=20 I know the software, but from a different point. What I may consider=20 not so important to describe, might be important for the user. So try=20 to imagine that you just installed Quanta and what would you want to do=20 with it. And document those steps that are needed to achieve what you=20 want. To see what I'm talking about: the current documentation is rather a=20 simple describing of different functions and features and not exatly a=20 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",=20 but if not, the best is to send. Also as we are only a few developers,=20 with other things to do as well, if you don't get replies for some=20 time, it might just mean, that you can go ahead as you think its the=20 best. This is rather natural with open source projects, especially=20 KDE. ;-) Do not worry, if somebody doesn't like something be sure that=20 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=20 > 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=20 (wiki.kde.org), which has some Quanta stuff, but sincerely I do not=20 follow it. Andras =2D-=20 Quanta Plus developer - http://quanta.kdewebdev.org K Desktop Environment - http://www.kde.org --nextPart1900694.6VnUq5g2Qu Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.5 (GNU/Linux) iD8DBQBFw12BTQdfac6L/08RApUlAKCAUSwsAFK6MG/5H8556tyjpLL7+ACfZMZ6 +lkQQihLL97G6X4AjYFTDZ8= =MNIy -----END PGP SIGNATURE----- --nextPart1900694.6VnUq5g2Qu-- --===============0801604121== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ quanta-devel mailing list quanta-devel@kde.org https://mail.kde.org/mailman/listinfo/quanta-devel --===============0801604121==--