Re: [fr-qa] Développement - Rédaction de l'aide

Bonjour Pierre-Yves,
On 29/01/2013 14:06, pierre-yves samyn wrote:
> Bonjour
>
> Dans sa réponse à ce fil:
>
> http://nabble.documentfoundation.org/Evaluation-des-processus-de-LO-par-des-etudiants-tp4029631p4032817.html
>
> Cédric explique clairement (#3) la relecture/validation nécessaire d'un
> autre développeur pour les commits.
>
> Je m'interroge quant à moi sur la rédaction/modification de l'aide
> consécutive 
> aux évolutions du code et des fonctionnalités.
>
> Existe-t-il un protocole, une procédure, etc. identique. Si oui quel est-il
> ?

oui, le même protocole que pour un patch, rédaction du patch , commit,
extraction sur Pootle, mise à jour de git.
> Prenons l'exemple de la nouvelle option Param. ling.> Langues> Ignorer la
> langue
> d'entrée du système. Aucune aide disponible (anglaise ni donc française), et
> non
> citée dans les notes de version (si j'ai bonne mémoire).
>
> Je prends cet exemple au hasard mais il est représentatif.
>
> A quoi sert une option non documentée, sera-t-elle bien utilisée, voire
> utilisée
> tout court ?

La plupart du temps l'aide vient après la fonctionnalité. Le système
d'aide utilisé par LibreOffice est du xml, ce qui rend compliqué son
écriture.

> Comment pouvons-nous (contributeur wiki, faq, doc, traducteur, etc.) faire
> notre "travail" voire envisager de proposer un texte d'aide ?

Si tu connais la structure, je pense que tu peux soumettre un patch, ce
sont des fichiers .xhp, voilà comment ça se présente :
<link href="text/swriter/01/05060200.xhp" name="No Wrap">No Wrap</link>
<embedvar href="text/swriter/01/05060200.xhp#keinumlauftext"/> You can
also choose this setting on the <emph>Wrap</emph> tab page.
<ahelp hid="HID_OLE_TOOLBOX">The<emph> OLE-Object </emph>bar appears
when objects are selected, and contains the most important functions for
formatting and positioning objects.</ahelp>
J'ai un doc des tags utilisés et divers outils que je n'ai pas testé
depuis très longtemps.
> Une aide / documentation non mise à jour induira en erreur les utilisateurs
> avec toute les conséquences...
>
> Mon souhait serait que toute modification générant une modification
> de l'aide ne puisse être intégrée qu'avec la modification induite dans
> l'aide.
>
> Dans l'idéal, nous pourrions presque demander que l'aide soit écrite *avant*
> le développement.

Ça ne s'est jamais fait, même du temps de OOo l'aide venait après
l'inclusion des fonctionnalités.
> Qu'en pensez-vous ?

Je laisse Cédric compléter exactement au niveau code
C'est vrai qu'il y a un gros travail de reprise à faire entre ce qui a
été retiré et ce qui a été modifié. L'idée de mettre l'aide sur le wiki
était de simplifier sa mise à jour, mais bon, c'est en fait difficile de
faire les conversions.
Je peux me renseigner plus avant au niveau code/patch/futur [mais après
la sortie de la 4.0] si tu es intéressé à travailler dessus.

À bientôt
Sophie

-- 
Sophie Gautier <sophie.gautier@documentfoundation.org>
Tel:+33683901545
Membership & Certification Committee Member - Co-founder
The Document Foundation

-- 
Envoyez un mail à qa+help@fr.libreoffice.org pour savoir comment vous désinscrire
Les archives de la liste sont disponibles à http://listarchives.libreoffice.org/fr/qa/
Tous les messages envoyés sur cette liste seront archivés publiquement et ne pourront pas être 
supprimés