Factoriser le contenu

Bonjour

En lisant cette discussion et en parcourant les tutos en cours de rédaction, il s'avèrent qu'un certain nombre de termes ou de notions sont partagés par différents contenus. Par exemple, dans le domaine du web : internet, protocole, la notion de client/serveur …

Il y a de forte chance que cette problématique se retrouve dans d'autre domaines.

Or, même si chacun peut trouver sa façon de le dire, il va arriver un moment où le différences entre chaque explication sera minime et on risque de se paraphraser. Il n'y aura donc pas nécessairement de valeur ajoutée à ré-écrire une définition de tel ou tel terme ou notion.

On pourrait utiliser des liens vers des services externe, genre Wikipedia pour faire cela, mais cela pose, à mon avis, un problème lors de l'export du contenu vers un format que je qualifierait de hors ligne, genre pdf ou epub, puisque certaines notions utiles ne seraient pas définies dans le document.

Je me demandais donc si il ne serait pas judicieux de créer un outils du genre glossaire vers lequel on pourrait faire pointer un lien dont la cible serait automatiquement ajoutée à la fin d'un document exporté. Bien évidement, aucun auteur n'est forcé de l'utiliser (chacun est libre de définir une notion à sa manière).

A votre avis, est-ce une idée qui mérite d'être creusée ?

Je pensais justement à ça ce matin : faire un tutoriel avec les notions de Qt (Model/View, signaux, …) sans code afin de pouvoir le réutiliser dans un tutoriel C++, Python (PyQt)…

D'autant plus que ça permettrait de travailler en équipe : si je souhaite pointer vers un contenu, je vais probablement le lire avec attention et, s'il y a des points à revoir, contribuer à l'améliorer.

Par contre, le terme cible mérite d'être détaillé. Pour l'exemple de la notion de client/serveur, il y aurait un tutoriel/article dédié à cela ? Dans le cas contraire, comment inclure du contenu lui-même inclus dans un tutoriel (par exemple, dans le cas où la notion de client/serveur serait abordée dans un paragraphe (paragraphe, pas extrait) d'un big tutoriel) ?

Par contre, le terme cible mérite d'être détaillé. Pour l'exemple de la notion de client/serveur, il y aurait un tutoriel/article dédié à cela ?

J'imaginais un truc de ce genre. Pour certain terme, cela peut même être très court, beaucoup plus court qu'un article en tout cas. C'est pour cela qu'il me semblait que ça ne rentrait pas dans un type de contenu déjà existant.

C'est exactement ça

Ok donc, l'idée serait d'avoir une sorte de base de connaissance "Notion" <-> "Explications" communautaire + la possibilité, dans le contenu, d'indiquer une référence à une notion de cette base ?

Exactement

Et comment se ferait ce lien ? Devoir cliquer sur 50 liens au cours de la lecture me paraît pénible, et une sorte d'intégration au contenu serait la bienvenue. C'est possible d'étendre le zmarkdown pour faire une insertion de contenu un peu comme avec les images ?

• Qui créditer pour chaque entrée si c'est rédigé de façon communautaire ?

Un peu curieux comme question… Les auteurs de l'entrée vraisemblablement. On peut imaginer quelque chose un peu comme dans certains livres de science où chaque auteur écrit une partie et est crédité comme tel.

• Qui a le droit d'éditer/créer des entrées ?

A priori, il faudrait à mon avis un coordinateur. On propose une entrée, elle est relue/améliorée et enfin intégrée à cette base de donnée. Tout le monde peut proposer, et si c'est justifié, alors elle sera intégrée.

• Validés ou pas ?

Cela me paraît nécessaire.

• Quid des notions avec plusieurs signification en fonction du contexte ?

Plusieurs entrées en fonction du contexte, comme toute encyclopédie ou dictionnaire un peu fonctionnel.

Une autre question importante pour moi :

• Quelle taille pour une entrée ? Est-ce qu'on fait quelques paragraphes/un paragraphes/quelques mots… ?

Un peu curieux comme question… Les auteurs de l'entrée vraisemblablement. On peut imaginer quelque chose un peu comme dans certains livres de science où chaque auteur écrit une partie et est crédité comme tel.

Si la notion a été éditer 50 fois par 50 personnes différentes, tu liste tous les noms ? Ou tu admet de base que c'est du contenu communautaire et que personne n'est crédité particulièrement ? Ou tu fait un mix (rien d'affiché particulièrement mais possibilité de consulter l’historique des modifs "àa la git/wiki") ?

Pour le reste je suis d'accord.

Quelle taille pour une entrée ? Est-ce qu'on fait quelques paragraphes/un paragraphes/quelques mots… ?

Je pense que ça dépendra beaucoup de la notion. Mais en soit on arrive aussi au problème du "niveau" requis pour comprendre l'explication : On vise le synthétique ? le complet ? L'adapté aux débutants ?

Il faut faire attention de ne pas tomber dans l'encyclopédique, ce n'est pas notre job. D'ailleurs pourquoi ne pas se contenter de wikipedia ? On peut imaginer un type de référence particulier pour wp, imaginons [wp-fr:Client-serveur]. Sur les versions en ligne tu aurais un liens vers la page http://fr.wikipedia.org/wiki/Client-serveur, voir un affichage dans un iframe au clic. Et pour le contenu off-line, on va par exemple récupérer l'intro via l'api de wikipedia et on la colle dans un cadre dédié ou dans des notes de fin de chapitre ou dans une annexe "notions" à la fin.

Le problème de Wikipédia, c'est que souvent, les prérequis supposés sont plutôt importants, en particulier pour les articles de Sciences et techniques… ou bien alors c'est très précis mais peu clair pour quelqu'un qui ne sait pas DÉJÀ ce que c'est.

Par exemple, l'article machine électrique de Wikipédia:

Une machine électrique est un dispositif électromécanique basé sur l'électromagnétisme permettant la conversion d'énergie électrique par exemple en travail ou énergie mécanique. Ce processus est réversible et peut servir à produire de l'électricité

Je suis persuadé qu'il y a plus clair pour un néophyte, et aussi plus direct et éventuellement avec une formulation moins alambiquée.

On pourrait parfois réécrire de manière plus concrète :

On appelle machine électrique une machine qui transforme de l'énergie électrique en énergie mécanique ou inversement. Cette conversion se fait par l’intermédiaire de phénomènes électromagnétiques. Exemples : génératrice synchrone, moteur à courant continu.

Je ne dis pas que c'est mieux, mais j'épargne au lecteur les notions de travail, de réversibilité, de dispositif électromécanique. On pourrait même perdre en précision et parler de conversion d'électricité en mouvement, en se passant du concept d'énergie.

Bref, il y a un niveau de simplicité nécessaire, qui n'est pas forcément présent sur Wikipédia. Après, si Wikipédia c'est bon, autant s'en servir ; mais je ne pense pas qu'on puisse tout faire avec (malheureusement).

Je ne defend pas spécialement wikipedia, j'expose des alternatives. Car pour moi, contrairement à ce qu'il y a dans le premier poste, je ne pense pas qu'utiliser wikipedia soit un problème technique. Apres si il ne répond pas à notre problème, tanpis. Jusque là on essai de minimiser les developpement en utilisant des services externes où c'est possible (youtube, jsfiddle, etc.). Certains fonctionnent très bien (youtube), d'autres risquent de poser plus de difficultés et risque de nous amener à des solutions "fait maison".

Bon, il semblerait donc que l'idée soit intéressante et mérite d'être discutée

Kje lève le point qui me semblait bloquant dans l'utilisation de Wikipedia : on peut intégrer uniquement son contenu grâce à l'API (bon exemple de terme à définir d'ailleurs ).

Le problème n'est donc plus d'ordre technique, mais plutôt du contenus à intégrer en lui même

C'est une excellente question : pour qui définir des notions ?

De façon caricaturale, on peut répartir ça en 2 niveaux de lecteurs:

• un tuto/article de niveau relativement élevé, dans le but de préciser l'utilisation d'un terme dans l'esprit de l'auteur. Pas certain dans ce cas que celui-ci utilise une fonctionnalité de ce genre.
• un tuto/article de découverte et de vulgarisation. L'outil me semble là plus pertinent. Et l'exemple donné par Aabu est frappant. Il me semble donner exactement les mêmes informations de façon plus simple.

Peut-être serait-il possible de lister, dans un domaine précis, les termes et notions à définir afin de voir si Wikipédia donne des définitions qui seraient satisfaisantes ?

En considérant ces extraits comme des tutoriels/articles à part entière, avec des auteurs précis, ne risque-t-on pas d'avoir des problèmes de droits ? Ou alors, il faudrait imposer la licence la moins restrictive.

De plus, que se passera-t-il avec l'interface de remerciements ? La publication du tutoriel en livre ?

Sinon, ne risque-t-on pas d'avoir une coupure au niveau du style d'écriture ? A ce compte-là, un tutoriel sur Python pourrait simplement être un assemblage de tuiles du genre "les fonctions en Python", "les générateurs en Python", "la POO en Python"…

Au niveau de la taille, je pense qu'il serait bien d'avoir un petit paragraphe introductif, puis un bouton "En savoir plus" qui nous ramène vers une page spécifique où tout est beaucoup plus détaillé.

@Vayel : Un tutoriel comme celui-là ne passera pas en validation. De toute façon, "les fonctions en Python" et autres ne semble pas êtres à factoriser. Des notions comme "API" doivent l'être car on peut les retrouver sur des tutoriels ne parlant du même sujet ("Utilisez l'API Twitter en C++" ( si elle existe ) et "Créez votre API REST" ça n'a rien à voir (à part la notion d'API)).