ZEP-34 Template de tutoriels

La zep-12 touchant à sa fin, il est temps de penser au futur et les derniers débats à propos de l'avenir du site ont montré que nous avions un besoin urgent de classifier et mettre en avant les tutoriels.

sujet de la ZEP

Cette ZEP traitera de deux outils aussi bien dans leur aspect IHM que de leur intégration dans le flux de rédaction.

Il s'agira de deux concept certes nouveaux mais qui doivent rester simples à l'utilisation :

• les templates (modèles/gabarit de rédaction)

Le concept

Les templates

Principes

• Les templates sont des outils pour les auteurs.
• Ils permettent de les guider dans l'élaboration d'un contenu en leur offrant des limites simples en nombre de parties, de section voire de taille. Ces templates sont aussi l'occasion d'ajouter des infobulles qui guident dans la rédaction.
• Je propose ces templates là :
  • Les tutoriels :
    1. Les mini tuto : pour décrire un point précis d'une technologie ou d'une science, ils ne sont composés que de sections, 2 au minimum + introduction et conclusion.
    2. Les tutoriels moyens : pour explorer une technologie ou une science. Ils sont composés de parties eux même directement composés de section + intro + conclusion. L'utilisation de parties est obligatoire, l'utilisation de chapitre est impossible.
    3. Le big tuto : pour décrire une technologie en s'épanchant sur tous les détails pédagogiques ou techniques nécessaires. Ils sont composés en partie + chapitres + section. Il est impossible de faire des parties sans chapitre
    4. Le tuto pulpeux : Libre d'écriture, il est limité par ce que permet la zep-12 : une partie contenant une section ne peut pas contenir de chapitre, une partie contenant des chapitres ne peut pas contenir de section. Idéal pour créer des introductions légères ou accessibles avant d'accéder au contenu proprement dit, ou bien des annexes plus exhaustives mais pas "sur organisées".
  • Les articles:
    1. Les brèves : une seule section, possiblement une limite de caractères : le but est de faire un contenu cours à propos d'une actualité, d'un fait marquant ou d'une bizarerie de ce monde
    2. Les articles de "seconde page" (nom à revoir, mais c'est issu du débat) : qui décrivent des phénomènes intéressant, voire poussés. Ils sont composés de plusieurs sections, pas de limites de caractères mais il est conseillé de ne pas dépasser 8 pages.
    3. Les dossiers (big up à Dominus) : des articles plus fouillés, souvent accessibles mais qui ont un contenu textuel plus fourni que les articles habituels. Ils sont comparables dans la forme aux "moyens tutos"

Intégration (spécifications)

Ces templates doivent être accompagné par une amélioration graphique de l'interface d'édition qui utilise plus des objets de type "tuile" ou tout autre issu du solid design. Ils doivent être sauvegardés dans le manifeste comme un champ non obligatoire, son absence étant alors interprété comme "tuto pulpeux" ou "article de seconde page" selon le cas.

(maquette à venir après débat)

L'appartenance à un template pourra être montrée au lecteur par un pictogramme visuel, un code couleur ou toute autre astuce graphique que la communauté jugera pertinente et non invasive.

Je ne suis pas certain que multiplier les templates soit réellement utile. Ca risque au contraire de compliquer et d'embrouiller. Au niveau des tutoriels, ce que tu proposes comme "tutoriel moyen", c'est juste un big-tuto avec une seule partie. En conséquence, un template dédié n'est pas utile. Si un big-tuto ne contient qu'une seule partie, il suffirait de ne pas énumérer les parties lors de la lecture du tutoriel. De plus, ça risque de limiter les possibilités : si je fais un moyen-tuto et que je décide d'ajouter une 2e partie par la suite, je serai bloqué… Ce qui ne sera pas le cas avec le template de big-tuto.

Le mot "fresque" pour qualifier les dossiers est, je trouve, totalement inadapté. "dossier" a l'avantage d'être compréhensible, alors que fresque… heu, tu vas nous parler de peinture ou de graffitis ?

c'est juste un big-tuto avec une seule partie

non. c'est un tutoriel qui a 5 parties sans chapitres.

il suffirait de ne pas énumérer les parties lors de la lecture du tutoriel.

pourquoi tenter de "ne pas énumérer" un truc qui n'existe pas. Cette zep se place post zep-12 qui retire toute notion de "mini/big" dans la création car c'est a priori pas possible d'expliquer quoi prendre quand on crée un tutoriel, surtout qu'on utilisait du dropdown.

Là l'idée serait vraiment de créer un vrai guide pour les auteurs. Uniquement pour eux. Avec l'information des gabarits, nous pouvons par exemple evoyer des conseils précis sur comment choisir son titre, ce qu'il ne faut pas faire, la densité de texte conseillée par section… en fonction de chacun des templates. En gros on peut guider l'auteur.

En ce qui concerne les tutoriels, je suis partagé entre la possibilité de structure flexibles et le risque que les gens s’emmêlent les pinceaux (moi le premier, j'ai ouvert un big-tuto pour voir concrètement à quoi correspondait une partie/section…). Sur les propositions, je me contente d'un "Pourquoi pas".

Pour les articles, je suis assez gêné par ce qui est proposé : quel est concrètement la différence, pour l'auteur, entre un article et un dossier ? La longueur ne me parait pas être un critère pertinent. Dans le cas de la brève, c'est le côté résumé qui la différencie d'un article, plus fouillé et complet. La longueur n'est qu'une conséquence.

Concernant le nom "articles de seconde page", que j'ai moi-même employé lors du débat : je parlais d'une différence non pas en longueur, mais en accessibilité. Une brève ultra-technique partait en "seconde page", un dossier accessible à tous restait en "première page" (bien que ces termes n'ont pas vraiment de sens actuellement, l'idée sous-jacente est "mis en avant"/"pas mis en avant").

Il y a une différence à faire entre le fond et la forme. Pour moi, un mini-tuto traite d'une chose unique, un big d'un thème. C'est le fond qui fait la différence. En permettant de faire, comme le propose Thunderseb, des big-tuto à une partie, on crée de fait les moyen-tuto. Pour les articles, c'est soit une présentation à un public de non connaisseurs (souvent), un approfondissement (j'ai pas d'exemple qui me vienne facilement, les gens font plutôt des mini-tuto, je pense), soit un résumé, qui a vocation à renvoyé ailleurs (une brève). La question de longueur disparaît. Avec une tel présentation, on n'a besoin que de deux formats.

D'où la question fondamentale : qu'est ce qu'on met derrière le format ? Simplement une question de longueur, ou un problème de fond ?

J'apporte mon avis, par forcément très ouvert :

• Les Tutoriels : Je pense qu'un tutoriel doit symboliser un thème. Imaginons la programmation orientée objet, et bien cela colle bien. On y apprend un maximum sur ce thème sans être exhaustif pour autant. Donc un Mini, Mid, Big fonctionne très bien. Ça doit représenter un cours. Avoir une direction précise dans laquelle on s'engage directement dès le début.
• Les Articles : Je présente les articles comme étant rapproché d'un sujet. Parlons par exemple du café, ou de la fonte des glace. Ce n'est pas un cours sur l’économie ni sur l’écologie, c'est un sujet abordé de plusieurs manière apportant des réponses et souvent pouvant s'apparenter à de la culture générale plus facilement qu'un cours ne l'aurais fait.

Une bonne distinction est qu'on peut généralement mettre des exercices dans une cours et pas sur un article.

Sauf que dans article il y a, pour moi, une notion temporelle. C'est un écrit sur un sujet du moment, une actualité, un événement particulier.

Par exemple, l'article "Vous dites que l'argent n'a pas d'odeur ?", pour moi c'est plus un mini-tuto, car ça ne rentre pas dans la description que je me fais des "articles". Mais c'est purement personnel, et je ne dois pas être le seul.

Alors je suis Ok avec l'idée d'actualité bien sur. Mais on apprend rien comme dans un cours réellement avec cet article. On en sait plus. Mais c'est de la culture Generale. Nous n'avons acquis aucunes compétence en neuromarketing. Désolé pour l'auteur hein.

Bah c'est peut-être ça le problème. Ce n'est ni un vrai article, ni un vrai cours. Du coup, wtf iz dat ?

Bah moi ça ne me dérange pas du tout d'avoir de l'actualité ou non dans un article. Je pense que ça correspond bien à a un sujet donné ce que j'ai précisé au début.

Je suis plus en phase avec Blackline en ce qui concerne les articles. Ceux sur le marketting ne posent pour moi aucun doute : ce sont des articles.

quel est concrètement la différence, pour l'auteur, entre un article et un dossier ? La longueur ne me parait pas être un critère pertinent.

Principalement la structure en ce qui concerne l'auteur, la longueur n'est ici qu'un effet collatéral. Pour le lecteur l'affichage sous forme de pages qui vient améliorer l'expérience de lecture.

En permettant de faire, comme le propose Thunderseb, des big-tuto à une partie, on crée de fait les moyen-tuto.

sauf que cette solution est vécue comme mauvaise par les auteurs à l'opposé de la suppression complète d'un niveau de hiérarchie (et Andr0 a déjà testé ça sur la zep12, il en a l'air content).

Pour les articles, je suis assez gêné par ce qui est proposé : quel est concrètement la différence, pour l'auteur, entre un article et un dossier ?

Je le répète, la structure. Et de ce fait l'évolution littéraire en est changée. Et pour les auteurs qui aiment bien sourcer, mettre 15 sources par page est plus facile que 45 sources en conclusion.

Donc article <=> mini tuto et dossier <=> tuto moyen, si je comprends bien.

Pour la distinction article/tuto, je plussoie totalement Blackline.

Si on regarde les articles publiées, assez peu ont une notion temporel. C'est peut-être pour ça qu'ajouter les brèves est nécessaire : ça permettrait de faire du contenu d’actualité, de revu, plus facilement. En effet, faire un article prend du temps, ce qui est peu compatible avec la notion temporel (même si on va tenter de le faire pour les Nobel/IgNobel).

Sinon, je suis OK pour les propositions.

Donc article <=> mini tuto et dossier <=> tuto moyen, si je comprends bien.

dans la structure, oui.

C'est peut-être pour ça qu'ajouter les brèves est nécessaire : ça permettrait de faire du contenu d’actualité, de revu, plus facilement.

C'est clairement pour ça que cette ZEP introduit la notion de "brève".

Merci pour cette ZEP.

La zep-12 touchant à sa fin, il est temps de penser au futur et les derniers débats à propos de l'avenir du site ont montré que nous avions un besoin urgent de classifier et mettre en avant les tutoriels.

Ayant suivi le débât, je comprends ce que tu veux dire, mais peut-être pourrais-tu expliciter cela ? Notamment, en quoi cette ZEP diffère-t-elle, dans ses objectifs, de la 25, 31 ou encore 32 ?

Ils permettent de les guider dans l'élaboration d'un contenu en leur offrant des limites simples en nombre de parties, de section voire de taille. Ces templates sont aussi l'occasion d'ajouter des infobulles qui guident dans la rédaction.

Ces templates ne décrivent donc que la structure du tutoriel, pas son contenu ? Autrement dit, ce sujet est-il lié à cette ZEP ?

Du coup, ne pourrait-on pas se contenter de conseils dans le guide du contributeur ?

Du coup, ne pourrait-on pas se contenter de conseils dans le guide du contributeur ?

Étant donné que zds a vraiment pris le chemin du partage de la connaissance au sens large et pas que dans le domaine de l' informatique mon parti est de dire que les gens qui redigeront ne sont pas tous informaticien et que lire une doc a chaque fois qu'on veut rédiger c'est pas adapté. Autant que faire se peut il faut que l' interface se suffise à elle-même. C'est pourquoi il faut abandonner les dropdown qui ne donnent aucun indice sur la manière de rédiger mais en plus il faut guider de début a la fin.

Pour la différence avec les autres Zep j'y reviendrai quand je ne serai plus sur mobile.

Étant donné que zds a vraiment pris le chemin du partage de la connaissance au sens large et pas que dans le domaine de l' informatique mon parti est de dire que les gens qui redigeront ne sont pas tous informaticien

Le guide du contributeur ne se résume pas au code, à l'aspect informatique. Ou alors j'ai mal compris ?

et que lire une doc a chaque fois qu'on veut rédiger c'est pas adapté

Pas forcément. Le mec qui ne veut pas de conseils et rédiger son truc en free-style, il appréciera ne pas devoir suivre de modèle, ni d'avoir des guidelines partout sur sa page.

En fait, ça dépend de ce qu'on vise avec cette ZEP. Considère-t-on ces templates comme de simples conseils ou carrément comme des modèles à suivre ? Veut-on qu'il devienne normal de suivre ces templates, ou souhaite-t-on les mettre uniquement pour guider les débutants ?

Le guide du contributeur ne se résume pas au code, à l'aspect informatique. Ou alors j'ai mal compris ?

relis bien ma phrase : le problème n'est pas le contenu du guide qui DOIT exister (il serait temps), mais le fait qu'il faut que l'interface face le job d'expliquer à quoi elle sert, plus précisemment il faut qu'elle soit si logique qu'à part cinq mot maximum dans un infobulle ou une petite aide contextuelle l'utilisateur sait comment l'utiliser. Le guide c'est pour le poweruser (demander à faire du JS, faire un déplacement, importer le .zip…)

Pas forcément. Le mec qui ne veut pas de conseils et rédiger son truc en free-style, il appréciera ne pas devoir suivre de modèle, ni d'avoir des guidelines partout sur sa page.

• il existe un template "freestyle"
• je parle d'ergonomie du site, pas des guidelines. Il faut que l'auteur sache où il en est à chaque moment et que tout soit fluide et évident pour lui. Il faut une interface légère mais qui est expressive et accessible, elle doit se suffire à elle même. Les guidelines c'est le travail de la betatest et des validos.

PS : j'éditerai ce message quand j'aurai terminé ma comparaison avec les autres zep.

différence avec la zep 25

la zep 25 :

• parle de la catégorisation thématique des contenus
• parle du manque d'uniformité dans l'interface pour les lecteurs (principalement)
• parle d'une meilleure accessibilité du menu principal

la zep 34 :

• parle de la catégorisation de la forme
• s'adresse aux auteurs
• améliore l'interface de rédaction en la rendant plus accessible
• couple la forme et le but même du contenu (un cours, une brève…)

différence avec la zep 31

heu j'ai du mal à voir le lien

différence avec la zep 32

j'ai vraiment du mal à voir le lien !

Des contenus du genre les vidéos de MicMaths, de minutephysics, de Veritasium… rentreraient dans la catégorie des brèves ?

Why not?