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

Bonsoir,

Le 29/01/2013 18:13, pierre-yves samyn a écrit :
> Suite...
>
> Merci Sophie pour les renseignements "techniques". Mais mon 
> interrogation ne porte pas trop là-dessus. Du moins pas tout de 
> suite... Quel que soit le support (wiki ou non, xhp, soumission de 
> patch, etc.) il faut "avoir de la matière" pour rédiger une aide, savoir 
> ce que fait la fonctionnalité, dans quel contexte on l'utilise, les limites,
> etc.
>
>
> sophi wrote
> > Ça ne s'est jamais fait, même du temps de OOo l'aide venait après
> > l'inclusion des fonctionnalités.
>
> Ok, je propose alors justement de changer cela : de même qu'un code doit 
> être "approuvé" par un autre développeur, ne pourrait-on pas (ne  devrait-on 
> pas) élargir le travail en commun, travailler avec la doc. dès ce niveau et 
> demander que l'inclusion d'un code soit dépendante d'un minimum de  
> documentation utilisateur si ce n'est de l'existence de l'aide ad hoc ?
>
> Les testeurs sauraient quoi et comment tester... et la documentation
> ferait partie des tests dès le départ.

Le problème c'est qu'avec un modèle de développement itératif, il est
illusoire de produire la doc en parallèle à l'écriture du code car
celui-ci évolue très vite et parfois change de direction sous l'effet
des tests "en direct" et des difficultés de codage. Il y a des fonctions
qui changent ou disparaissent, etc. Le cas du gestionnaire de modèles
est typique de cela. Il faut donc attendre que le développement ait
atteint un état stable (à partir duquel il n'y aura probablement plus de
grosses remises en question) avant de commencer à produire la
documentation.

En revanche dans le cas de l'ajout d'une case à cocher dans un dialogue
d'options, on pourrait espérer que la production de l'info-bulle, de
l'info-ballon et du paragraphe de documentation dans l'aide de ce dialogue.

Je pense qu'il y a, avec ce problème de la documentation, un créneau sur
lequel des non-codeurs peuvent intervenir sur le code pour produire la
documentation de base en anglais. C'est à mon avis une part manquante du
processus de développement qui reste à mettre en place. On pourrait sans
doute élaborer le processus avec le gestionnaire de modèles. La première
étape est de savoir comment on crée et intervient sur l'aide.
Apparemment il n'y a pas de tuto pour l'expliquer.

Bonne soirée
JBF

-- 
Seuls des formats ouverts peuvent assurer la pérennité de vos documents.

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