Rédiger sur zeste, c'est quand même un peu difficile

Mon retour

a marqué ce sujet comme résolu.
Auteur du sujet

Je rebondis sur le post de @Abdelazer : https://zestedesavoir.com/forums/sujet/9442/rediger-sur-zeste-cest-quand-meme-un-peu-complique/

Ceci afin de ne pas lui « hacker » le sien.

Donc oui, je voulais aussi faire mon retour d’expérience, car je vois que je ne suis pas le seul.

Je ne peux que confirmer le calvaire de la rédaction sur ZdS. C’est paradoxal. Le site et l’interface sont propres, les gens sont dévoués (je remercie encore une fois tous les bénévoles, changez pas ! <3 ), mais on capte rien du tout, c’est un fouillis sans nom. Dès que tu veux faire un truc qui te semble simple, c’est compliqué. J’ai failli abandonner plusieurs fois (j’ai fait des pauses plusieurs fois de plusieurs mois tellement c’est une souffrance).

Petite histoire

J’ai commencé la rédaction de mon tuto. Première galère, Partie/chapitre/section. Ah, mais j’ai des boutons qui s’affichent ou se masquent suivant je ne sais quoi (comment faire une demande sur le forum sur un truc qu’on comprend pas…).

Je tente zWriter, ouf, je comprends enfin un peu mieux les concepts et j’ai fait une grosse partie de mon tuto avec (~50 %), mais le mécanisme d’upload d’image est inexistant (ou bien j’ai pas compris), je ne sais pas pourquoi, je ne comprends pas ce qui se passe sous le capot, je décide de revenir a l’interface Web.

Je trouve ça pas pratique, puis, a l’époque, impossible de masquer des parties de son tuto. Je décide de laisser tomber ZdS et de convertir mon tuto pour un site statique que je mettrai en ligne, je commence a faire du Python (je suis dev Python) pour avoir un système de génération de site statique de tuto en utilisant le zMarkdown dispo sur github. C’est difficile, J’abandonne.

Je me décide à terminer mon tuto.

Mécanisme de validation imbitable (mon tuto a fini par être valide, mais j’ai aucune espèce d’idée du comment de qu’est-ce qui c’est passe sous le capot il y a des beta, du brouillon, des en validation, des publiés), mais, encore une fois, je suis très bien aide (gros merci a @Aabu !). On a l’impression de ZdS a été pensé par des validateurs, tout le mécanisme semble tourner autour de ça avec des étapes bien spécifiques qui au final, je pense complexifie un peu le truc.

Ce que je pense qu’il serait intéressant de creuser. Je mets tout en vrac.

Aucune documentation clair/accessible sur la structure d’un tutoriel

Ça c’est le pire quand tu commences. Il nous faut un tuto sur la rédaction d’un tuto. C’est quoi un chapitre, une partie, une section ? Qui peut être mis dans quoi ? Tu peux mettre des sections dans une partie mais uniquement si elle n’a pas de chapitre. J’ai fait un big tuto et je l’apprends maintenant parce que le menu est « caché si tu as déjà un chapitre dans ta partie » WTF ? Pourquoi cacher ce genre de chose ? C’est tellement important. Montrez le lien « + Ajouter une section », grisez-le et mettez une tooltip dessus « Impossible de créer une section car elle contient déjà des chapitres. Une partie ne peut être compose que de chapitres, ou de section. »

Juste ça, ça aiderait a fond !

Comment peut-on comprendre si ce genre de choses est caché ? On ne peut même pas demande de l’aide sur le forum. Car on demanderait de l’aide « pour quoi » ?

On commence à comprendre en allant voir des pages perdus sur le site, des pages comme « Guide du contributeur », « Rédiger sur ZdS », et sûrement d’autre car, vu qu’elles ne sont référencées nulle part, bah on tâtonne, on cherche, parfois on perd du temps à demander sur les forums.

Il devrait y avoir une section « Aide » dans le menu de gauche accessible depuis n’importe quel endroit du tuto qu’on rédige.

Dedans on y mettrait les pages qu’on juge nécessaire a la rédaction d’un tuto :

  • « Guide du contributeur »: J’ai appris que cette page existait au milieu de la rédaction de mon tuto (après 6 mois).
  • « Formatage du texte » qui pointe vers le tuto « Rédiger sur ZdS ».
  • Et sûrement d’autres car, bah j’en ai pas trouvé d’autre alors que je n’aurais jamais du avoir a les chercher.

Si vous connaissez reddit, l’aide au formatage est accessible directement sous le formulaire de texte et il dispose d’un lien vers une page dédiée. C’est ce genre de chose qu’il faut avoir en tête : « Proposer l’aide a l’endroit ou l’utilisateur en aurait besoin.

Placer une image dans son tuto est un mécanisme rébarbatif.

Je sais qu’il y a des choses qui ont été faites récemment. Moi j’aimerais faire des copier-coller dans mes tutos pour pas me prendre la tête (dans un premier temps) et avoir une page contenant les images « pas utilisées » qui seront supprime dans les 15 jours.

Ça permet de s’éviter l’administration des images pendant qu’on fait sa rédaction, quitte a le faire après.

La gestion des « versions » des images n’est pas utile celons-moi.

Bah si ! On peut le faire, il suffit d’aller ici et de faire …

Et voila le fond du problème. Tu passes ton temps à chercher et à poser des questions (que tu ne devrais pas avoir a te poser) sur le forum. Questions qui sont souvent difficiles à poser car, justement, tu captes même pas comment la formuler.

L’interface doit se suffire à elle-même pour ce qui est de la rédaction de tutos. Il ne doit pas y avoir de logique cachée (pitié ne cachez pas les choses, montrez-les et expliquer pourquoi on ne peut pas agir dessus, c’est 1000x plus compréhensible).

Encore une fois, je suis vraiment en admiration devant l’implication des bénévoles (c’est sincère, le fait d’avoir vu des gens se donner du mal pour m’aider m’a aussi boosté à finir mon tuto), mais il y a un problème de fond sur la prise en mains du site par des gens qui n’ont pas envi de papoter sur le forum, pas envi de fouiller les tréfonds du site pour trouver une info, mais qui ont juste envi de rédiger un tutoriel.

Je ne souhaite blesser personne et j’écris ça uniquement dans le but de faire remonter mon « ressenti », forcement subjectif dans l’espoir que ça aide a faire avancer les choses.

+7 -0

Salut salut !

Je te remercie chaleureusement pour ce retour, il est plus qu’utile. En fait une partie non négligeable de l’état actuel de l’interface est directement due au manque de retours : pendant un long moment si les développeurs ne cassaient rien, aucun retour n’était fait, on ne savait donc pas ce qui était bien et ce qu’il fallait améliorer. On a réussi à trouver un équilibre désormais et ça nous permet d’avancer. Des gens comme @abdezlazer et @situphen ont déjà fait un bon boulot d’UX, là on a A-312 qui s’y intéresse, du coup on commence forcément à faire bien bouger les choses.

En parlant de bouger les choses, aujourd’hui tu peux ajouter une image par simple copier/coller dans ton tuto, aucun soucis là dessus. Pour la suppression des images non utilisées, faudra voir ce qu’on peut faire, mais c’est clairement pas pour tout de suite, ça paraît être une feature assez peu prioritaire.

Pour l’aide, on s’améliore petit à petit, notamment avec les différentes PR de @abdelazer, on va prendre en note tes retours, on les intégrera dès qu’on pourra, mais ça ne devrait pas prendre 3 ans.

Ça c’est le pire quand tu commences. Il nous faut un tuto sur la rédaction d’un tuto. C’est quoi un chapitre, une partie, une section ? Qui peut être mis dans quoi ? Tu peux mettre des sections dans une partie mais uniquement si elle n’a pas de chapitre. J’ai fait un big tuto et je l’apprends maintenant parce que le menu est « caché si tu as déjà un chapitre dans ta partie » WTF ? Pourquoi cacher ce genre de chose ? C’est tellement important. Montrez le lien « + Ajouter une section », grisez-le et mettez une tooltip dessus « Impossible de créer une section car elle contient déjà des chapitres. Une partie ne peut être compose que de chapitres, ou de section. »

C’est ce qu’on appelle une erreur d’UX. Ce fonctionnement a été décidé par deux développeurs purement backend (pierre et moi si tu veux des noms), personne ne nous a rien dit à part "chouette on peut faire des tutos moyens" et "la distinction chapitre/partie/section c’est compliqué" donc on n’a jamais vraiment modifié l’expérience utilisateur à ce propos. C’est donc une réflexion à avoir dans le futur, merci pour ce retour tr_s intéressant.

Édité par artragis

+2 -0
Auteur du sujet

@artagis, cool que ce soit bien pris. :)

(pierre et moi si tu veux des noms)

AU BÛCHER !!! :pirate:

personne ne nous a rien dit à part "chouette on peut faire des tutos moyens" et "la distinction chapitre/partie/section c’est compliqué"

Je me doute que les retours de tout le monde rendent l’ensemble difficile à garder cohérent.

Concernant le "la distinction chapitre/partie/section c’est compliqué". Je pense que c’est complique parce que c’est mal expose. Mais le cacher, ça rend le truc encore moins clair.

J’avoue ne pas avoir des masses de solutions à proposer a par faire en sorte de ne pas avoir à rechercher de l’aide mais de l’avoir a gauche.

Concernant la partie "chapitre/partie/section" Je ne crois pas qu’elle est complique. Je crois que si tu fais une présentation comme ça ça passe :

DEBUT DE LAIDE

Une section c’est:

  • Un titre
  • Du texte.

Une partie c’est

  • Un titre
  • Une intro
  • Des sections
  • Une conclusion

Un chapitre

  • Un titre
  • Une intro
  • Des parties
  • Une conclusion

Vous pouvez, optionnellement, intercaler des sections entre les parties.

Exemples d’organisation de tuto

Un petit tutoriel, compose uniquement de chapitres.

Comment manger des pommes (tuto)
  Peler une pomme (section)
  Couper une pomme (section)
  Manger la pomme (section)

Un tutoriel compose de parties :

Comment manger des fruits (tuto)
  Les pommes (Partie)
    Peler une pomme (section)
    Couper une pomme (section)
    Manger la pomme (section)
  Les poires (Partie)
    Peler une poire (section)
    Couper une poire (section)
    Manger la poire (section)
  Les scoubidoubidous (Partie)
    Peler un scoubidou (section)
    Couper un scoubidou (section)
    Manger le scoubidou (section)

Un gros tutoriel compose de chapitres :

Comment s'alimenter (tuto)
  Manger des fruits (chapitre)
    Les pommes (Partie)
      Peler une pomme (section)
      Couper une pomme (section)
      Manger la pomme (section)
    Les poires (Partie)
      Peler une poire (section)
      Couper une poire (section)
      Manger la poire (section)
    Les scoubidoubidous (Partie)
  Manger des legumes (chapitre)
    Les tomates (Partie)
      Peler une tomate (section)
      Couper une tomate (section)
      Manger la tomate (section)
    Les courges (Partie)
      Peler une courge (section)
      Couper une courge (section)
      Manger la courge (section)
    Les bananes (Partie)
      Peler une banane (section)
      Couper une banane (section)
      Manger la banane (section)

Et puis on peut tout combiner !

Comment s'alimenter (tuto)
    Manger des fruits (chapitre)
        Les pommes (Partie)
            Peler une pomme (section)
            Couper une pomme (section)
            Manger la pomme (section)
        Les poires (Partie)
            Peler une poire (section)
            Couper une poire (section)
            Manger la poire (section)
        Les scoubidoubidous (Partie)
            Peler un scoubidoubidou (section)
            Couper un scoubidoubidou (section)
            Manger la scoubidoubidou (section)
        Les autres fruits (section)
    Manger des legumes (chapitre)
        Particularité des légumes par rapport aux fruits (section)
        Les tomates (Partie)
            Peler une tomate (section)
            Couper une tomate (section)
            Manger la tomate (section)
        Les courges (Partie)
            Peler une courge (section)
            Couper une courge (section)
            Manger la courge (section)
        Les bananes (Partie)
            Peler une banane (section)
            Couper une banane (section)
            Manger la banane (section)
    Note sur l’hygiène (section)

C’est quoi un mini tuto, un moyen tuto et un big tuto ?

Afin de vous aider à mettre en place un tutoriel, on vous propose de commencer avec un plan de tutoriel déjà prêt a l’emploi :

  • Mini tuto: Un tuto compose uniquement de sections.
  • Moyen tuto: Un tuto compose de parties et sections.
  • Gros tuto: Un tuto compose de chapitres, parties et sections.

Mais aussitôt votre tutoriel créé, vous pouvez en faire ce que vous voulez.

Rien ne vous empêche de créer un gros tuto pour ensuite supprimer tous les chapitres, et n’y avoir que des sections. C’est vous qui en faites ce que vous voulez. :)

FIN DE LAIDE

Vous voyez l’idée. Un tuto de tuto. Cette page (ce tuto) "Structure d’un tutoriel" pourrait être accessible depuis le menu à gauche de l’aide ET directement depuis la page de création de tuto.

Voila voila.

Ne jamais oublier les "schémas" quand on explique les choses (@artagis, c’est ton schema sur l’autre billet qui m’a permis, d’un coup, de tout comprendre), même textuel, ça permet d’aider l’autre à se faire une idée du concept qu’on est en train de lui passer.

D’une manière générale, si cinq lignes de textes peuvent être résumé en un schéma, alors il faut schématiser puis, ensuite seulement, expliquer en "décrivant ce qu’on peut faire". Dans mon exemple:

Rien ne vous empêche de créer un gros tuto pour ensuite supprimer tous les chapitres, et n’y avoir que des sections. C’est vous qui en faites ce que vous voulez. :)

C’est cette ligne qui confirme que le fonctionnement Mini/Moyen/Gros n’est qu’une pour gagner du temps.

En espérant que ça aide. :)

+1 -0
Comment s'alimenter (tuto)
    Manger des fruits (chapitre)
        Les pommes (Partie)
            Peler une pomme (section)
            Couper une pomme (section)
            Manger la pomme (section)
        Les poires (Partie)
            Peler une poire (section)
            Couper une poire (section)
            Manger la poire (section)
        Les scoubidoubidous (Partie)
            Peler un scoubidoubidou (section)
            Couper un scoubidoubidou (section)
            Manger la scoubidoubidou (section)
        Les autres fruits (section)
    Manger des legumes (chapitre)
        Particularité des légumes par rapport aux fruits (section)
        Les tomates (Partie)
            Peler une tomate (section)
            Couper une tomate (section)
            Manger la tomate (section)
        Les courges (Partie)
            Peler une courge (section)
            Couper une courge (section)
            Manger la courge (section)
        Les bananes (Partie)
            Peler une banane (section)
            Couper une banane (section)
            Manger la banane (section)
    Note sur l’hygiène (section)

Ceci est… strictement impossible : on ne peut pas ajouter une section dans une partie qui a déjà un chapitre, on ne peut pas ajouter un chapitre dans une partie qui a déjà une section.

pour petit/moyen/big tuto il n’y a pas de définition précise, si ce n’est que :

  • si tu écris directement des sections à la racine de ton tuto on dira plutôt que c’est un mini tuto
  • si tu ne crées que quelques parties dans lesquelles tu vas directement écrire les sections, on dira que ton tuto est un "tuto moyen", l’exemple le plus connu est matomo analytics
  • si tu fais un tuto avec des parties et des chapitres et que c’est dans les chapitres que tu mets les sections on dira que c’est un "big tuto".

après l’éditeur te donne un petit peu de liberté, tu peux par exemple faire ça :

+
|- partie 1 (exemple "installation des outils")
+---+
    |- section 1 (exemple "installation sur windows")
    |- section 2 (exemple "installation sur linux")
+- partie 2 (exemple "le coeur du sujet")
    |
    +- chapitre 1
       + section 1
       + section 2
    +- chapitre 2
       + section 1
       + section 2
+- partie 3 (exemple "Aller plus loin")
    |
    +- chapitre 1
       + section 1
       + section 2
    +- chapitre 2
       + section 1
       + section 2
+- partie 4 (exemple "annexes")
    +- section 1
    +- section 2

le MP auquel Naalan fait allusion.
+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