Collaboration sur la Documentation

J’ai commencé à lire Diataxis, c’est chouette. Puisque ça en parle, j’en profite pour faire un big up aux tutoriels :point_up: !
Avec la doc CLUB1 on a une section tuto qui est très sympa à écrire avec les membres. Ça permet de rester factuel et précis sur le reste et ça fait des petites aventures, genre des quêtes à accomplir : c’est excitant !

On a aussi exploré la fonctionnalité Glossaire, qui permet de faire un tampon entre la doc et wikipedia pour pas que ça soit trop rude d’être jeté direct dehors.
Côté outil, on utilise Sphinx (Markdown +Rst) et on profite de la version PDF imprimable en Latex.
→ article qui présente la mise en place de la doc

Concernant la mise en commun, c’est vrai que c’est un casse tête vu la diversité des façons de faire et des configs. De notre côté on a pas trop de NextCloud ou trucs dans le genre, donc moins en commun facile. Par contre quand on s’attaquera à la doc de Matrix, c’est clair qu’on ira piocher des idées chez les autres CHATONS.

3 « J'aime »

Oui, absolument :sunglasses: Il suffit d’aller sur la page des exports et par exemple télécharger le fichier .ods de la ligne services puis l’ouvrir dans un tableur (LibreOffice…) et alors les informations sont dans la colonne K :smiley_cat:

3 « J'aime »

Bonjour! Désolé, je n’ai pas encore fait de post de présentation

J’adore cette notion de « quête » @vincent-peugnet pour approcher les ressources et/ou l’apprentissage !
Le monde de la sécurité informatique part lui en capture de drapeaux pour s’exercer :video_game:

Et si le journal de quêtes apprenait à nager ? :thinking:


Extrait de « DigComp | cadre de référence européen des compétences numériques »

Ici pour le Français :
https://oce.uqam.ca/digcomp-cadre-de-reference-europeen-competences-numeriques/

https://joint-research-centre.ec.europa.eu/digcomp/digcomp-framework_fr
pour l’anglais :roll_eyes:

DigComp + Framework Diataxis (cc @quentin) + saisie de contenu formalisé à inventer (cc @pierre @Angie)

Saisie de contenu à formaliser :

  • documentation collaborative (orienté diataxis)
    • tutos
    • explications
    • références
    • fiches pratiques
  • demande de support
    • bug (joindre screenshots, logiciels, versions, …)
      • Épingler les problèmes connus (incompatibilités, en cours de résolution…)
    • aide (‹ Je cherche à faire › ; ‹ J’ai donc entrepris › ; ‹ Je n’arrive pas ›)
      • résolution des demandes (Voir telle fiche pratique, Ajout d’explications)
  • scénarios qui parcours des tutos et fiches pratiques
  • … ?

Peut-être des liens à faire entre une question de support, une question d’auto-évaluation et une question de FAQ ? Qui vont produire des explications, fiches pratiques, références et tutos ?

Aussi, m’est d’avis qu’il est urgent d’entreprendre autre chose que beta.gouv.fr/startups/pix

On comprends vite le malaise avec un namespace pareils /startups.

Svp :face_holding_back_tears:, un groupe de travail nager . chatons . org


@pyg C’est Pierre-Yves de Framasoft ?
Je serai preneur de ton avis sur ce ‹ service public › : ‹ produit pérennisé ›,‹ incubé › puis ‹ sponsorisé › (rien que ça!) par nos ministères :face_with_raised_eyebrow:


Archivé sur la wayback machine pour les sciences sociales du futur

Chez Framasoft, vous pensez ouvrir des groupes de paroles pour CNFS désabusé.e.s/démissionné.e.s ?

Rappelons que Pix :nauseated_face: est/va devenir un parcours obligé dans les écoles si j’ai bien suivi ? (pour les précaires itou)

1 « J'aime »

Quel entousiame :slight_smile:

On discutait doc avec @reminec et je me disais, il faut que je lui communique ce que j’ai en tête à ce propos, et plutot que ce soit dans un chat privé, ici, c’est beaucoup mieux!

Tout d’abord merci beaucoup @quentin pour ton partage, du coup, il faut que je lise tout (j’ai déjà lu ~50% et c’est fascinant!).
Et il me semble que j’ai déjà une première quête, aider à automatiser la traduction de diataxis en fr :wink:

Ensuite, en ce qui concerne mon impliquation, mon intuition est que là où je peux être le plus utile est d’assister les personnes qui veulent documenter/traduire avec mes compétences techniques.
Et à priori, ce ne sera pas avant Juin, ce moment magique où tu sais qu’il n’y a pas grand chose dans le planning et tu penses que tu es libre, mais tu dis cela sur plusieurs choses, et en fait, ce moment s’appelle le déni :wink:
(Et les personnes d’Indie gèrent leur prio comme iels veulent :wink: )

Bonne soiree et bon weekend!

Sujet intéressant qui demande effectivement des ressources, du temps et vérification à chaque mise à jour des logiciels

@quentin : merci pour le partage, très intéressant.

Pour la partie outil, j’aime bien MkDocs qui est léger, très simple à utiliser (fichier markdown) et à partager via un repo GIT.

Bonjour @reminec

C’est quoi CNFS ?

Nous avons déjà eu des discussions autour de pix sur ce forum https://forum.chatons.org/t/pix-fr-soutient-les-gafam/4180 . Et plus généralement, nous avons eu l’occasion de parler éducation aux médias et éducation à l’occasion du dernier camps chaton.

Pas grave, je sait comment soigner cela. Une bouteille de vin rouge issu des coteaux Belges aop et Hop, des discussions hilarantes.

Conseiller National France Service ; pardon pour la digression ça concerne guère la documentation (quoique).
Je me questionnais à éditer mon poste pour enlever ce pâté émotionnel

plutôt Conseiller Numérique France Service…
voir : Conseillers numériques France Services | Agence nationale de la cohésion des territoires

1 « J'aime »

@mrflos C’était bien moi sur gitlab, mais j’avais envoyé un autre message via le formulaire de contact YesWiki où je demandais des infos techniques sur l’approche Clônage de la structure de données de la forge :
« Est-il possible de cloner un YesWiki, puis de contribuer sur le clone, et à un moment faire remonter les modifications upstream (quitte à ce que ce soit fait par un admin qui gère les conflits via git)? Ca donnerait une sorte de fédération de wiki, où chacun pourrait prendre et améliorer tout ou parti de la base de données centrale. »

Je plussoie le Markdown+Git (actuellement il y a encore beaucoup de wikis), cf mon lien où j’explique markdown et des outils de conversion possibles

Hello @GautGaut je continue le HS sur YesWiki mais promis c’est le dernier: à l’heure actuelle, on peut importer/dupliquer du contenu par api rest, export/import de modeles de wiki, et import/export de contenus de fiches de base de données en csv, mais il n’y a pas d’historique et d’upstream à la git, cela nécessite une intervention d’une personne admin du wiki pour faire ces imports/export ponctuellement.

C’est une option envisagée pour YesWiki mais par encore opérationnelle et cela prendra du temps avant d’être disponible comme une fonctionnalité de base.

Les dépots git avec du markdown me paraissent la meilleure solution pour partager et laisser chacun.e récupérer les fichier et les faire s’afficher avec l’outil de son choix, mais à voir si éditer les fichiers markdown dans par exemple un outils comme gitlab est assez accessible pour les personnes non techs.

1 « J'aime »

Je plaiderais pour la mise-en-place d’un nouveau wiki dédié à la documentation utilisateur finaux. Je trouve les exemples basés sur des éditeurs markdown collaboratifs très parlant :

J’ai créé un tableur pour comparer les différentes solutions wiki possibles et les contraintes pour rendre la contribution la plus ouverte aux non-tech possible.
https://ethercalc.nomagic.uk/=dsudwdo1zh

Une fois l’outil choisi on pourra réfléchir à appliquer Diataxis pour définir la structure du wiki. Et enfin il suffira d’aller piocher dans les meilleures doc’ pour faire un best-off complet :smiley:

1 « J'aime »

Je lance un sondage de dates pour une réunion pour trouver une vision commune et des synergies. On pourrait y expérimenter des outils, comme bookstack ou autre.

1 « J'aime »

Le projet m’intéresse, par contre je ne pourrai pas me prononcer sur ces dates proches, trop d’activité me retiennent…

Bonjour,

C’est un beau projet.
On est occupé à faire des docs de notre côté aussi (Nubo pour le système mis en place et DomainePublic pour des docs d’usage plutôt), mais c’est lent vu le peu de temps qu’on a pour ça.
Ce sera une bonne idée de se référencer de l’un vers l’autre, mais à voir quand on aura avancé là-dessus. Je garde un oeil par ici.

1 « J'aime »

Pas chaud, de plonger directement dans les outils.

Je m’abstiens pour ce coup-ci.
Je serai ravis de lire des retours d’expériences cela dit.

@pierre m’a soufflé dans l’oreillette un mot de vocabulaire qui me manquait : https://www.metacartes.cc/faire-ensemble/recettes/documentation-croisee/

Voilà qui synthétise ce que j’aimerais mettre en place, via Tedomum.net (et d’autres?) courant 2023.

1 « J'aime »

Context : J’embarque chez Tedomum, (officiel depuis Dimanche 11 mars 2023 milieu d’AG), initialement c’était pour ajouter un noeud à l’entre’hébergement.
L’idée est intacte, mais mes volontés se sont diversifiées au fur et à mesure.

J’espère ne pas être trop péremptoire dans le ton ou le propos, je serais ravi d’y mettre du non-verbal lors de rencontres en présentiel :slight_smile: (Prochaine occase : JDLL - Lyon)

Je dois vous avouer mon imparfaite maîtrise des nuances entre savoirs / connaissances / capacités)

Je précise ce qui me taraude en dépilant tout droit :

  • Le matraquage culturel (au mauvais endroit? pas dans la doc en tout cas)
  • Prendre les utilisateurices pour des incapables
  • Se retrouver à être exhaustif pour un logiciel précis plutôt qu’un usage précis
  • Ne pas faire le lien entre les questions de support et la base de documentation

Prenons l’exemple d’un logiciel de visioconférence.

M’est d’avis qu’en sortant d’une fiche pratique ‹ utiliser un logiciel de visioconférence ›, on en ressort avec :

  • Des savoirs :

    • Les us & coutumes d’une visioconférence
      • C’est mieux si le micro ne capte pas les bruits ambiant
      • C’est mieux de repérer en amont comment couper son micro
      • Ça va être dur de comprendre où est le soucis si on ne parle pas en continue pendant les traditionnels ‹ Allo m’entends tu? › (puis plus rien, j’attends que ça se passe tout seul)
      • Avoir la notion qu’on se coupe vite la parole à cause du micro-delai
      • Avoir la notion que si on parle en même temps, personne n’y comprend rien
    • On peut potentiellement activer/désactiver son micro, sa caméra
    • On peut potentiellement ajuster le son des personnes
    • On peut potentiellement partager son écran
    • On peut potentiellement ‹ lever la main ›
    • On peut potentiellement y trouver une zone de tchat textuel
    • On peut potentiellement un outil de vote / sondage
    • On peut potentiellement réagir (via des smiley)
    • Une vague idées des outils libre ou non libre à notre disposition
  • De vagues connaissances sur les erreurs classiques :

    • Des fois, ce n’est pas le bon périphérique qui est configuré (Pas de son/Pas de micro)
    • 2 personnes dans la même pièce sur haut-parleurs avec 2 micros, ça fait de l’écho

Ainsi, la fiche pratique ‹ Utiliser jitsy › devrait se résumer à quelques screenshots ou une vidéo d’usage, les fonctionnalités présentes et absentes pour un logiciel de visio et… roulez jeunesse ?

Pour les cas plus spécifique, ici la doc (en anglais pourquoi pas), là le support.

Et le support c’est l’élément au centre de mon attention :
Si il y a une question, c’est qu’il y a un besoin d’éclaircissement, ou un bug (certainement déjà connu?).
« A nous » de favoriser les réponses détaillées aux questions, et de trouver la bonne place où les faire remonter dans la base de documentation.
Tout pareil, si il y a un bug connu du logiciel, ou du service chez un chaton en particulier, il faut qu’il saute aux yeux.

C’est notre prochain chantier chez Tedomum : Un gros bandeau en accueil pour dire que notre Jitsy, il est actuellement dans les choux pour une conversations à plus que 2 :upside_down_face:

Et enfin pour élargir, merci au collectif ‹ Lost In Médiation › pour leur série de billets, dont celui-ci : Où est donc passée la culture numérique ? – Framablog

M’est d’avis que ça pollue plus qu’autre chose le fait de rappeler ‹ le libre c’est bien › au milieu d’une doc logiciel.
C’est un critère de choix, qui logiquement est déjà fait si on tombe sur ladite doc.

Et sans culture, la doc n’y pourra absolument rien.
Malgré les screenshots qui au démeurant doivent évoluer aussi vite que l’outil.

Merci de m’avoir lu jusqu’ici si c’est le cas, désolé pour la longueur :sweat_smile:

4 « J'aime »

À cette occasion, je ne manquerai pas de te rappeler que tu nous dois une bière :wink: Et si cela t’intéresse, j’y animerai cette conf|atelier https://pretalx.jdll.org/jdll2023/talk/YQHX7H/ dans laquelle, en creux, on comprends comment un manque de culture numérique émancipatrice conduit inexorablement à nous rendre dépendant à quelques technologies et à quelques bigtech.

2 « J'aime »

Pour l’instant le sondage de dates converge vers le Mardi 28 Mars 2022 à 20h00

J’ai créé un pad pour un ordre du jour et une prise de notes collectives : Etherpad MyPads
J’ai commencé à y résumer les échanges de ce post.

Hello, sujet super intéressant :slight_smile:

Je ne crois pas l’avoir vu mentionné, mais pensez-vous qu’il serait pertinent d’avoir un outil gérant le multilingue ? C’est sans doute trop tôt dans la réflexion, et vu les différents points techniques soulevés par les partages d’articles et autres documentations, pas dit que ce soit pertinent puisque les approches culturelles peuvent compliquer le travail de traduction.

Bref, je suis preneur de vos avis :slight_smile:

Coucou tout le monde

Tout ces chantiers que vous lançez en ce moment sont intéressants et utils. Il serait important que je suive ça pour m’assurer de l’accessibilité des outils utilisés. Malheureusement je n’ai pas du tout le temps et lénergie pour le moment de m’occuper de tout ça.

2 « J'aime »