[Kde-games-devel] Docbooks commit memorandum.

[Burkhard Lück]

Am Donnerstag 15 November 2007 02:03:11 schrieb Eugene Trounev:
> Dear KDEgames,
>
> First and foremost please allow me to publicly apologize on behalf of
> KDEgames Docteam for the severe lateness on our part, as well as add
> that this will not happen again in the future.
>
No reason for the KDEgames Docteam to apologize, you did a great job (even if 
I have >13 updated/fixes docbooks with about 500 changed lines here ;-)).

kdegames was the only module with a complete rewrite of the documentation for 
4.0.
Looking at my commit filter (for _all_ doc directories of all main kde 
modules) I see only few commits for docs in other modules (edu, pim, 
graphics).
Therefore the games will have the best documentation in kde 4.0 for the next 
years.

We need something like a regular doc unfreeze (i.e. a week every month) to get 
rid of all the outdated/buggy documentaition. 
I have translated/proofreaded/fixed about half of the kde docs and I know the 
bad quality of the our docs. 
I want to change this!

And as a translator I do not want to work with outdated and buggy docs, that 
is useless.

Am Donnerstag 15 November 2007 02:13:27 schrieb Mauricio Piacentini:

> Well, I think that things like typos should still be corrected, so a
> review should be conducted anyway. This does not affect translators imo,
> and having typos or grammar errors (IF they exist) in the default
> English documentation is not acceptable. Of course, I am talking only
> about small single-word corrections, not reorganization of menus,
> improvement of sections, etc. Do you guys see any issue with this? Am I 
> right in considering that doc translation is not similar to GUI
> translation, in the sense that the translator has to do the whole doc
> anyway, so correction of a typo would not interfere with it?

A change of one char in a docbook makes it impossible to generate the language 
docbooks as long as the template extraction and one run of scripty is 
missing.
This is no problem for me (either I do the template generation and scriptys 
job on my local checkout or pick up the correct versions of 
docbooks/templates etc from kde svn), but for many other teams.

Burkhard Lück
(german doc translator for acess, games, graphics, part of edu, office)