Re: New tool to correct Documentation

Hello Nuno, Le Vendredi 14 Avril 2006 14:00, Nuno Lopes a écrit : > Bonjour, > > I already knew that the French team was using that tag. Although it may > help to have a better quality documentation, I think we (English team) > can't afford to "waste" time with it. > I maintain a list of commit messages in my inbox that need to be > documented. Well, in the last months it has grown to about 160 messages. > That's a lot of stuff to document.. Probably we all read the commit > messages from others, and that's the best way to review our manual. (and we > also have the manual notes and bug reports when someone else finds a > problem). > > And having this for the main documentation source isn't good for > translation teams. Can you imagine the hundreds of no-content-change > commits you would have to be in sync with? (I'm always worried about the > French and Japanese teams, which are always up-to-date). > > So, I don't really agree to use this tag in the English documentation. I think that you have not understand what the French Documentation Team means. We want to include systematically the reviewed tag in the translated documentation (*not* in EN documentation). We have the Chance (FR Team) to have a reviewer (Hi David :p) and we need to have a reviewed tag to help his job. This tag help here to see what files he must review, just that. I have make a script to help you to know what we want. I have commit it in the cvs script directory and you can view the output here : http://php.keliglia.com/index_reviewed.htm I think this script (and this reviewed tag) can help translator's team to make a translated documentation better. Regards, > > Nuno > > > ----- Original Message ----- > > > Hi docteam, > > > > This mail is to explain a new feature we would like to implement to help > > not only translators but all people to double check the documentation. > > As far, in french documentation, we are using for each xml file a tag > > located at the beginning of the file: <!-- Reviewed: yes -->. As you can > > see, the tag is set to "no" when a "translator" writes it and after, a > > reader has to correct mistakes and has to switch it to "yes". > > Normally, when a sync has to be made with english documentation, the > > translator judges if the sync he has made is big enough to switch it to > > "no" (if previously set to yes)... > > > > So, for other languages, this could be useful too to know if a file has > > been corrected. For english, this tag could be used too... a doc writer, > > and a doc reader :) > > > > The project is to make something like the revcheck to display which file > > has been read and which has to be read. Is it a better idea to create a > > new "project" or incorporate it into the actual revcheck...? > > We are wondering if this kind of project is already handled in other > > language documentation, and if not, we are ready to make it. > > > > We would like to know your opinion about this project. > > > > > > French Doc Team > > > > -- > > Jean-Sébastien Goupil > > jsgoupil@gmail.com -- Yannick