ZEP-03 : Page résumant les tutos en rédaction

L'auteur de ce sujet a trouvé une solution à son problème.
Auteur du sujet
Cartouche
ZEP 3
Titre Page résumant les tutos en cours de rédaction
Révision 5
Date de création 14 juillet 2014
Dernière révision 06 septembre 2014
Type Feature
Statut En Prod !

Le contexte de la proposition

De nombreuses personnes aiment se rendre utile et voudrais rédiger un tuto ou participer à la rédaction d'un tuto. Certains rédacteurs aimeraient aussi pouvoir trouver un collaborateur, illustrateur, correcteur pour les aider à avancer. Cette page permettrait de mettre en avant ces demandes de manière synthétique.

Objet de la proposition

Nous serions en présence d'une page listant tout les tutos en cours de rédaction. Des icônes ou autres indicateurs graphiques permettent de voir rapidement si un recrutement est possible. Cette page permet aussi de savoir ce qui est en cours d'écriture. Un tutoriel ne doit apparaître que si l'auteur de ce dernier le souhaite.

Comment cela se présente

  • La page reprendra tout les tutos (et une autre pour les articles) si une des options ci-dessous est cochée, sinon il n’apparaît pas.
  • On pourra afficher :
    • Un lien vers la version beta
    • Une demande d'aide pour la rédaction
    • Une demande d'aide pour la correction
    • Une demande d'aide pour l'illustration
    • Une proposition de "transmission" du tuto (L'auteur ne souhaite plus écrire le tuto, et souhaite que X le reprenne pour lui. Il sera alors mentionné dans le tuto comme auteur historique mais ne sera plus dans la liste des auteurs actifs). Un lien vers la version publiée sera aussi affiché si elle existe

Toutes les options sont par défaut à l'état "désactivés" lors de la création d'un tutoriel.

La mise en relation se fera "manuellement", une icone "contacter le(s) auteur(s)" sera proposées et mènera alors vers un nouvel MP dont les destinataires pré-remplis seront les auteurs du tuto en question et le sujet sera quelque chose du genre "Collaboration - {Titre du tuto}".

L'ensemble pourra être synthétisé dans un tableau a plusieurs colonnes. Chaque colonne représente une option avec un pictogramme présent ou non si l'option est active ou non. On trouvera aussi des colonnes pour afficher le nom du/des auteur(s) et le titre du tuto.

Des filtres seront présents dans la sidebar pour n'afficher que certains criteres ("n'afficher que les tutos ayant besoin d'un illustrateur" par exemple).

Les demandes d'aides possibles sont "extensibles" par l’équipe éditoriale (de nouvelles aides peuvent donc apparaître si le besoin s'en fait ressentir).

Ressources nécessaire

Je serais intéressé pour me charger du développement cette ZEP lorsqu'elle sera validée. Cependant, je ne suis pas graphiste et donc ne suis pas en mesure de proposer les icones nécessaire au tableau, a savoir :

  • Icone "tuto en beta"
  • Icone "tuto en ligne"
  • Icone "Besoin d'aide pour la rédaction"
  • Icone "Besoin d'aide pour la correction"
  • Icone "Besoin d'aide pour l'illustration"
  • Icone "Je laisse ce tuto a qui le veux"
  • Icone "Contacter le(s) auteur(s)"

Un ticket GH pour reprendre le contenu de cette ZEP sera crée à l'issue de la validation de cette dernière.

Annexes

PR pour suivre le développement : https://github.com/zestedesavoir/zds-site/pull/1499

Des bisous a :

Tout les devs pour leurs aides, retours, ajouts, modifs… Ça a été un travail de longues haleines qui a nécessite des apports sur plein de niveaux différents (back, front, fixtures, QA…) et nous aura occupe un bon moment ! On se souviendra de gustavi (ou artragis ?) qui avait dit "C'est cool se sera pret pour la v1.2"… La belle époque :D

Bref, un superbe boulot, 37 commits, trouzmilllions rebase (sur mon git local je dois avoir une dizaine de branches "Zep3-…", un bon paquet de jurons pour maudire git, mais une grosse satisfaction a la fin et un beau succes pour ZdS et la redaction / creation de contenus communautaire.

Bref, bravo a tous !

Édité par Eskimon

ZdS, le best du Zeste ! Tuto Arduino, blog, etc

+20 -0

Pour moi, aucune des cases que tu ne propose ne doit être cochée par défaut, pour laisser le choix à l'utilisateur qui reste maître de son projet :-)

EDIT : suite à une interpellation d'Eskimon sur IRC, je me réexplique :

L'idéal, ce serait de mettre les tags/catégories en évidence. Je m'explique à moins d'être graphiste/correcteur et d'avoir envie de mettre mes compétences à disposition, si j'arrive sur cette page, ce serait intéressant que je vois que certaines catégories requièrent de l'aide (genre "c++", "ah tient, j'ai des compétences en c++, allons voir ça"). Je sais pas quelle forme ça pourrait avoir (nuage de tag?), mais ce serait intéressant. De la même manière, cette page signalera que quelqu'un est en train d'écrire un tuto dans une certaine catégorie. Si je suis auteur, il serait bien que cette page mette en évidence que le domaine possède déjà un certain nombre de tuto en rédaction (avec évidement, toujours la possibilité de voir que certains tutos demandent de l'aide). Une fois encore, j'ai pas trop d'idée comment rendre ça visuellement, mais le but, c'est que ces deux informations sautent aux yeux, ce qui sera plus difficile sur une liste pure (qui n'est pas inutile, évidement).

Édité par pierre_24

Doctorant et assistant en chimie à l'Université de NamurEx-dev' pour ZdS (a aidé à réaliser la ZEP-12 !) • Carniste cis (y parait que c'est une injure)

+1 -0
  • Ajout d'options dans la page de rédaction d'un tutoriel pour spécifier si :
    • L'auteur souhaite que le tuto apparaisse dans la liste
    • L'auteur recherche un correcteur
    • L'auteur recherche un collaborateur
    • L'auteur recherche un illustrateur
    • L'auteur abandonne son projet et propose une reprise par un tiers

Eskimon

Je propose que la première option ne soit pas modifiable par l'auteur et soit implicitement activée quand n'importe laquelle des autres options est choisie. La raison étant que je ne vois pas d'intérêt à seulement montrer que l'on rédige sur un sujet si on ne cherche aucune aide.

On me répondra que ça peut tout de même être utile pour que des auteurs potentiels ne se marchent pas sur les pieds en rédigeant tous sur le même sujet, mais personnellement je pense que ce n'est pas dans l'intérêt du site. Ce serait dommage qu'un auteur décide d'abandonner la rédaction d'un tutoriel parce que quelqu'un d'autre en écrit un sur le même sujet (et qu'il ne souhaite pas d'aide).

À part ce point mineur, je trouve que cette ZEP est une excellente idée pour encourager la collaboration et éviter les tutoriels prometteurs abandonnés. :)

+4 -0
Auteur du sujet

L'idéal, ce serait de mettre les tags/catégories en évidence. Je m'explique à moins d'être graphiste/correcteur et d'avoir envie de mettre mes compétences à disposition, si j'arrive sur cette page, ce serait intéressant que je vois que certaines catégories requièrent de l'aide (genre "c++", "ah tient, j'ai des compétences en c++, allons voir ça"). Je sais pas quelle forme ça pourrait avoir (nuage de tag?), mais ce serait intéressant. De la même manière, cette page signalera que quelqu'un est en train d'écrire un tuto dans une certaine catégorie. Si je suis auteur, il serait bien que cette page mette en évidence que le domaine possède déjà un certain nombre de tuto en rédaction (avec évidement, toujours la possibilité de voir que certains tutos demandent de l'aide). Une fois encore, j'ai pas trop d'idée comment rendre ça visuellement, mais le but, c'est que ces deux informations sautent aux yeux, ce qui sera plus difficile sur une liste pure (qui n'est pas inutile, évidement).

pierre_24

Est-ce qu'un mécanisme de "filtre" serait pas plus adapté ? On garde la liste "brutal et longue" en entrée de jeu et ensuite on peut filtrer via les tags pour éliminer des résultats. Quand penses-tu ?

Je propose que la première option ne soit pas modifiable par l'auteur et soit implicitement activée quand n'importe laquelle des autres options est choisie. La raison étant que je ne vois pas d'intérêt à seulement montrer que l'on rédige sur un sujet si on ne cherche aucune aide.

On me répondra que ça peut tout de même être utile pour que des auteurs potentiels ne se marchent pas sur les pieds en rédigeant tous sur le même sujet, mais personnellement je pense que ce n'est pas dans l'intérêt du site. Ce serait dommage qu'un auteur décide d'abandonner la rédaction d'un tutoriel parce que quelqu'un d'autre en écrit un sur le même sujet (et qu'il ne souhaite pas d'aide).

SimSonic

Je ne sais pas trop… Un auteur peut avoir envie de dire "je suis en train de rédiger sur ca" sans pour autant vouloir dire "Je cherche activement un collaborateur". Ca permet notamment aux lecteurs de consultes ce qui est en cours de rédaction (pour éviter de se retrouver avec des sujets "Un tuto machin est-il en rédaction ? Parce que ca m’intéresse j'aimerais apprendre la dessus !"


Je rajoute une fonctionnalité : Lien vers la dernière version public/beta publié. Je suppose qu'il faudra aussi trouve un moyen de déclarer un tuto comme "fini" pour qu'il arrête d’apparaître dans la liste ?

Édité par Eskimon

ZdS, le best du Zeste ! Tuto Arduino, blog, etc

+0 -0

Est-ce qu'un mécanisme de "filtre" serait pas plus adapté ? On garde la liste "brutal et longue" en entrée de jeu et ensuite on peut filtrer via les tags pour éliminer des résultats. Quand penses-tu ?

Ça peut marcher aussi :) (avec en plus un filtre "correction" et "graphisme").

Je ne sais pas trop… Un auteur peut avoir envie de dire "je suis en train de rédiger sur ca" sans pour autant vouloir dire "Je cherche activement un collaborateur". Ca permet notamment aux lecteurs de consultes ce qui est en cours de rédaction (pour éviter de se retrouver avec des sujets "Un tuto machin est-il en rédaction ? Parce que ca m’intéresse j'aimerais apprendre la dessus !"

+1

Je rajoute une fonctionnalité : Lien vers la dernière version public/beta publié. Je suppose qu'il faudra aussi trouve un moyen de déclarer un tuto comme "fini" pour qu'il arrête d’apparaître dans la liste ?

Eskimon

Ça peut se faire avec le passage en validation ou le passage en publication (j'avoue que je vois des avantages aux deux situations, genre "ok, je me suis fait valider, on m'as dit de corriger mon orthographe, help les gens").

Doctorant et assistant en chimie à l'Université de NamurEx-dev' pour ZdS (a aidé à réaliser la ZEP-12 !) • Carniste cis (y parait que c'est une injure)

+0 -0
Auteur du sujet

Ça peut se faire avec le passage en validation ou le passage en publication (j'avoue que je vois des avantages aux deux situations, genre "ok, je me suis fait valider, on m'as dit de corriger mon orthographe, help les gens").

Oui mais un tuto validé/publié n'est pas forcement terminé.

Sinon pour illustrer via un exemple que je connais bien:
le tuto Arduino a plus de 3 ans d'existence et est toujours en écriture :D . Je/On ne cherche pas d'autres auteurs, mais plutôt un correcteur et illustrateur si jamais. Le tuto est dans une version très très avancé qu'on pourrait considérer comme terminé, mais des nouveaux chapitres voit régulièrement le jour.
Un tel tuto devrait-il être dans la liste ?

ZdS, le best du Zeste ! Tuto Arduino, blog, etc

+0 -0

Pour moi oui. Et donc, ça fait une raison de plus que la "première case" reste au choix de l'auteur : il arrête quand il veut :)

(après, si le tuto est déjà publié, l'argument "je coche juste pour montrer que je fait un tuto" tient plus, puisqu'il est déjà présent)

EDIT : limite, dans le MP de validation, rappeler l'existence de ce mécanisme

Édité par pierre_24

Doctorant et assistant en chimie à l'Université de NamurEx-dev' pour ZdS (a aidé à réaliser la ZEP-12 !) • Carniste cis (y parait que c'est une injure)

+0 -0

Je ne sais pas trop… Un auteur peut avoir envie de dire "je suis en train de rédiger sur ca" sans pour autant vouloir dire "Je cherche activement un collaborateur". Ca permet notamment aux lecteurs de consultes ce qui est en cours de rédaction (pour éviter de se retrouver avec des sujets "Un tuto machin est-il en rédaction ? Parce que ca m’intéresse j'aimerais apprendre la dessus !"

Eskimon

Entre quelques sujets de membres qui se demandent s'il y a un tutoriel en rédaction sur un sujet, et un auteur potentiel qui décide de ne pas se lancer dans la rédaction parce qu'il a vu qu'un autre écrivait déjà à propos de son sujet, personnellement je préfère de loin la première option.

+0 -0
Auteur du sujet

Donc pour résumer et faire avancer la ZEP :

  • La page reprendra tout les tutos (et une autre pour les articles) si une des options ci-dessous est cochée, sinon il n’apparaît pas.
  • On pourra afficher :
    • Un lien vers la version beta
    • Un lien vers la version publiée si elle existe
    • Une demande d'aide pour la rédaction
    • Une demande d'aide pour la correction
    • Une demande d'aide pour l'illustration
    • Une proposition de "transmission" du tuto (L'auteur ne souhaite plus écrire le tuto, et souhaite que X le reprenne pour lui. Il sera alors mentionné dans le tuto comme auteur historique mais ne sera plus dans la liste des auteurs actifs).

L'ensemble pourra être synthétisé dans un tableau a plusieurs colonnes. Chaque colonne représente une option avec un pictogramme présent ou non si l'option est active ou non. On trouvera aussi des colonnes pour afficher le nom du/des auteur(s) et le titre du tuto.

Des filtres seront présents dans la sidebar pour n'afficher que certains criteres ("n'afficher que les tutos ayant besoin d'un illustrateur" par exemple).

ZdS, le best du Zeste ! Tuto Arduino, blog, etc

+5 -0
Staff

j'ai déjà expliqué pourquoi cette solution ne sera pas celle choisie

Ça me gêne terriblement quand tu affirmes tes choix de façon aussi catégorique. C'est la communauté qui décide, collectivement, pas toi tout seul de ton côté (peu importe que tu aies raison ou pas).

Sinon pour la ZEP, ok pour moi aussi. Ça va être une fonctionnalité très utile !

Suivez ZdS sur Twitter ! Et venez aux JZDS Lille !

+6 -0
Auteur du sujet

Cool que ca plaise et que ca s'approuve !! (si un DTC (nohar ou spacefox) veut/peut passer par la pour approuver la redaction du premier message ce serait super :) )

Du coup je me pose une question sur le process de dev… Vu que les ZEP 8 et 12 vont toucher aux tutos, dois-je attendre pour faire le dev' ou puis-je m'y mettre avant et faire en sorte de finir avant eux ? (parce que bon, il faut pas non plus des tartines de dev' pour cette feature)

ZdS, le best du Zeste ! Tuto Arduino, blog, etc

+0 -0
Staff

Du coup je me pose une question sur le process de dev… Vu que les ZEP 8 et 12 vont toucher aux tutos, dois-je attendre pour faire le dev' ou puis-je m'y mettre avant et faire en sorte de finir avant eux ? (parce que bon, il faut pas non plus des tartines de dev' pour cette feature)

Vu qu'elles ne sont pas entamés, tu peux y aller je pense.

+0 -0
Vous devez être connecté pour pouvoir poster un message.
Connexion

Pas encore inscrit ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte