Revision as of 15:32, 27 April 2020

Processus de relecture des documentations

Nous suggérons d'utiliser la méthode de relecture suivante:

Choisissez une documentation sur cette page et prévenez le coordinateur des documentations.
Lancez check_doc_po pour vérifier l'orthographe (via ispell) et la conformité avec nos propres règles (les règles d'orthographe et le dictionnaire de kword). Si check_doc_po détecte des erreurs en trop, ne les corrigez pas.
Lancez check_gui_texts pour vérifier que les éléments de menus, les messages et autres éléments de l'interface utilisateur correspondent bien entre la doc et l'application. Si au passage vous découvrez que l'erreur est aussi en anglais, notez-la dans un coin de fichier pour envoyer en bloc à l'équipe anglophone. Ne corrigez pas l'erreur par le biais de la traduction - attendez d'abord que ce soit corrigé en anglais. En clair : traduisez les erreurs.
Ouvrez le centre d'aide de KDE (khelpcenter) et l'application en même temps (Bien entendu, tout le monde a depuis longtemps KDE 3.1 installé..), et relisez la documentation. Vérifiez au passage que les copies d'écran sont traduites. Sinon, effectuez-les. N'ouvrez pas la documentation dans le fichier po ni dans le fichier docbook : uniquement dans le centre d'aide. Pour les captures d'écran, les consignes sont :
- Image semblable à l'original, de même nom.
- Résolution 24 bits (mais 16 sont très bien).
- Enregistrement png.
- Thème Keramik, couleurs par défaut.
- Tenir compte du texte pour faire la capture.
- S'il est difficile ou impossible de faire une capture d'écran qui correspond au texte de la doc, notez le problème dans le fichier qui sera envoyé à l'équipe anglophone, et laissez tomber cette copie d'écran. Ne tentez pas de modifier le po.
À la fin, fournissez au committeur qui dispatchera :
- la liste des erreurs de traduction dans le po de l'application;
- la liste des erreurs de la version anglaise (texte ne correspondant pas à l'application, texte ne correspondant pas aux copies d'écran, typos, contenu erroné);
- la liste des erreurs de traduction dans le po de la documentation.

@@ Line 4: / Line 4: @@
 * Choisissez une documentation sur cette page et prévenez le coordinateur des documentations.
-* Lancez check_doc_po pour vérifier l'orthographe (via ispell) et la conformité avec nos propres règles (les règles d'orthographe et le dictionnaire de kword). Si check_doc_po détecte des erreurs en trop, ne les corrigez pas.
+* Lancez <code>check_doc_po</code> pour vérifier l'orthographe (via <code>ispell</code>) et la conformité avec nos propres règles (les règles d'orthographe et le dictionnaire de kword). Si <code>check_doc_po</code> détecte des erreurs en trop, ne les corrigez pas.
-* Lancez check_gui_texts pour vérifier que les éléments de menus, les messages et autres éléments de l'interface utilisateur correspondent bien entre la doc et l'application. Si au passage vous découvrez que l'erreur est aussi en anglais, notez-la dans un coin de fichier pour envoyer en bloc à l'équipe anglophone. Ne corrigez pas l'erreur par le biais de la traduction - attendez d'abord que ce soit corrigé en anglais. En clair : traduisez les erreurs.
+* Lancez <code>check_gui_texts</code> pour vérifier que les éléments de menus, les messages et autres éléments de l'interface utilisateur correspondent bien entre la doc et l'application. Si au passage vous découvrez que l'erreur est aussi en anglais, notez-la dans un coin de fichier pour envoyer en bloc à l'équipe anglophone. Ne corrigez pas l'erreur par le biais de la traduction - attendez d'abord que ce soit corrigé en anglais. En clair : traduisez les erreurs.
 * Ouvrez le centre d'aide de KDE (khelpcenter) et l'application en même temps (Bien entendu, tout le monde a depuis longtemps KDE 3.1 installé..), et relisez la documentation. Vérifiez au passage que les copies d'écran sont traduites. Sinon, effectuez-les. N'ouvrez pas la documentation dans le fichier po ni dans le fichier docbook : uniquement dans le centre d'aide. Pour les captures d'écran, les consignes sont :
 ** Image semblable à l'original, de même nom.