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

Bonjour,
On 30/01/2013 08:57, Cedric Bosdonnat wrote:
> On Tue, 2013-01-29 at 23:20 +0100, Jean-Baptiste Faure wrote:
> > 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.
>
> Oui tout a fait d'accord. Meme encore a l'heure actuelle, je ne sais pas
> si l'UI du template manager ne va pas encore evoluer un peu etant donne
> les problemes remontes par l'equipe UX (fondes ou pas).

Ce qui a toujours été le cas également au temps de OOo. L'aide était
implémentée dans les versions intermédiaires.
> > 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.
>
> Oui, pour des modifications mineures il est plus facile d'avoir l'aide
> avant (meme certains developpeurs l'ecrivent eux-meme).

Je pense qu'il vaut mieux commencer par les petites modifications qui
nécessistent dans l'aide déjà pas mal de modifications
--> insertion dans l'index
--> infoballon d'explication
--> description de la fonction
--> réalisation des liens si elle apparaît ailleurs

> Par contre pour des gros morceaux comme le template manager, je ne me
> sens pas l'ame d'un redacteur ;)
>
> > 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.

Je pense que le gestionnaire de modèle est trop compliqué pour un début.
Le problème n'est pas tant la rédaction de la fonction qui doit rester
très succinct (c'est une aide, pas une doc), mais à nouveau la
compréhension et l'apprentissage de la structure de l'aide.
> Ca pourrait surement aider de produire un tutoriel, en effet.

Ok, je veux bien demander de l'aide sur la liste dev pour l'avoir. S'il
y a des gens motivés ici pour écrire de l'aide, les devs seront motivés
eux-aussi ;) De même si vous le souhaitez, je fais un modèle
d'implémentation des rubriques.

À 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