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

Le 29/01/2013 14:06, pierre-yves samyn a écrit :
> 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
> ?
>
> 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 ?
>
> Comment pouvons-nous (contributeur wiki, faq, doc, traducteur, etc.) faire
> notre "travail" voire envisager de proposer un texte d'aide ?
>
> 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.
>
> Qu'en pensez-vous ?
>
> Cordialement
> Pierre-Yves

Bonjour Pierre-Yves,

Je souscris. Une nouvelle fonctionnalité sans documentation équivaut à 
quelque chose de flou, et aura toujours des conséquences inattendues 
côté utilisation.

D'autre part, elle rend problématique la recherche d'erreurs ou de 
dysfonctionnements. La documentation seule permet de lever ces doutes.

Pas d'intégration de nouvelle fonctionnalité sans aide ad-hoc serait une 
très bonne chose. L'idéal, l'aide écrite  "avant" le développement est 
une bonne pratique pas toujours facile à mettre en œuvre.

Amicalement,

Jacques


--
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