Aide en ligne

23 views
Skip to first unread message

Laurent ROCHE

unread,
Jul 10, 2017, 4:00:07 AM7/10/17
to tryton-fr
Salut,

Je sais que ça fait un peu old school : mais pourquoi ne pas avoir une
aide en ligne (par F1 et/ou un bouton supplémentaire) qui afficherait
une page HTML dans une fenêtre pop-up, avec des explications sur la page
qu'on est en train de visualiser ?

Je sais qu'il y a déjà des bulles d'aide sur certains champs mais une
page d'aide globale permet de présenter des notions plus générales et/ou
complexes qui ne sont pas liés à un seul champ.

Sur mes projets, je mets toujours une page d'aide par écran ... et
j'impose qu'elle soit écrite avant la première ligne de code : la page
d'aide remplace les spécifications, elle décrit comment doit fonctionner
l'écran. Et quand on fait des modifications, c'est pareil. Du coup, on
sait ce qu'on va faire, et l'aide en ligne est à jour.

Je me rends bien compte que je prends le train en marche et qu'il y
aurait beaucoup de travail pour tout faire mais cela peut être fait
petit à petit au fur et à mesure des nouveaux développements.

Aujourd'hui, démarrer avec Tryton est très difficile car il n'y a aucune
documentation utilisateur. La documentation existante
(http://doc.tryton.org/4.4/) est une documentation pour les développeurs.
De plus, comme je l'ai déjà dit, mon expérience est, que rédiger la page
d'aide de l'écran que l'on va créer (ou modifier), aide grandement le
développeur à clarifier ses idées. Même si au départ, peu de
développeurs à qui j'ai imposé le concept, n'étaient chauds, au final,
ils en ont tous reconnu l'intérêt.

Bref, je lance une idée.


PS : comment ça se fait que les messages que je poste sur
tryt...@googlegroups.com mette plusieurs heures à arriver ? C'est
googlegroups qui met du temps à processer les messages ?


---
Cheers,
L@u
The Computing Froggy
http://computing.travellingfroggy.info

Dominique Chabord

unread,
Jul 19, 2017, 1:01:44 PM7/19/17
to tryton-fr
Le 9 juillet 2017 à 19:20, 'Laurent ROCHE' via tryton-fr
<tryt...@googlegroups.com> a écrit :
> Salut,
>
> Je sais que ça fait un peu old school : mais pourquoi ne pas avoir une aide
> en ligne (par F1 et/ou un bouton supplémentaire) qui afficherait une page
> HTML dans une fenêtre pop-up, avec des explications sur la page qu'on est en
> train de visualiser ?
>
> Je sais qu'il y a déjà des bulles d'aide sur certains champs mais une page
> d'aide globale permet de présenter des notions plus générales et/ou
> complexes qui ne sont pas liés à un seul champ.


Nantic a fait une proposition pour créer une telle page de
documentation il y a 4 ou 5 ans.
Ils appelaient cela documentation utilisateur, moi j'y voyais plutôt
un manuel de référence dynamique.
Je pense qu'ils ont poussé le développement suffisamment pour obtenir
une documentation fonctionnelle dynamique en espagnol ou en catalan.
Il faudrait regarder le code qu'ils ont produit à cette occasion.

>
> Sur mes projets, je mets toujours une page d'aide par écran ... et j'impose
> qu'elle soit écrite avant la première ligne de code : la page d'aide
> remplace les spécifications, elle décrit comment doit fonctionner l'écran.
> Et quand on fait des modifications, c'est pareil. Du coup, on sait ce qu'on
> va faire, et l'aide en ligne est à jour.

Dans le cas d'un logiciel dont les modules sont optionnels, c'est un
peu plus compliqué que ça. C'est en cela que la proposition Nantic
était intéressante. Elle fabriquait l'aide en ligne qui correspondait
aux modules activés, en présentant les vues réelles et je crois me
souvenir dans la langue de l'utilisateur.
Je n'ai pas vu de retour sur l'efficacité de cette documentation. Je
suis sceptique sur la pertinence qu'on peut apporter à l'utilisateur
de cette façon, mais, justement cette expérience était la meilleure
façon de savoir.
Cette proposition a rencontré des objections à l'époque, mais si elle
présentait un intérêt réel, la réflexion pourrait être reprise.

Au final, ça pourrait ressembler à ce que tu proposes.

>
> Je me rends bien compte que je prends le train en marche et qu'il y aurait
> beaucoup de travail pour tout faire mais cela peut être fait petit à petit
> au fur et à mesure des nouveaux développements.
>
> Aujourd'hui, démarrer avec Tryton est très difficile car il n'y a aucune
> documentation utilisateur. La documentation existante
> (http://doc.tryton.org/4.4/) est une documentation pour les développeurs.
> De plus, comme je l'ai déjà dit, mon expérience est, que rédiger la page
> d'aide de l'écran que l'on va créer (ou modifier), aide grandement le
> développeur à clarifier ses idées. Même si au départ, peu de développeurs à
> qui j'ai imposé le concept, n'étaient chauds, au final, ils en ont tous
> reconnu l'intérêt.

Je ne pense pas qu'il faille revenir à des méthodes de développement
piloté par l'interface externe sur Tryton, je n'y vois pas de sens,
mais je suis ouvert aux arguments.
On pourrait plutôt imaginer le test-driven development. En est-on encore loin ?

Cédric Krier

unread,
Jul 19, 2017, 1:50:05 PM7/19/17
to tryton-fr
On 2017-07-19 19:01, Dominique Chabord wrote:
> On pourrait plutôt imaginer le test-driven development. En est-on encore loin ?

Tous nos nouveaux développements vont dans ce sens. Les modules ont un
ou plusieurs scenario. Les corrections de bugs ont le plus souvent un
test de non régression (si l'écriture du test n'est pas trop complexe).

--
Cédric Krier - B2CK SPRL
Email/Jabber: cedric...@b2ck.com
Tel: +32 472 54 46 59
Website: http://www.b2ck.com/
Reply all
Reply to author
Forward
0 new messages