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 
(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
- Les us & coutumes d’une visioconférence
-
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 
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 
4 « J'aime »
À cette occasion, je ne manquerai pas de te rappeler que tu nous dois une bière 
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
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
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 »
Avec @GautGaut on a mis en commun un ODJ-CR.
Il y a les urls pour la visio et le lien du sondage de date/présence si d’autres volontaires ?
A priori, rdv 20h sur le bbb.
(cc @fabrice61 @plabuse)
Voici le compte-rendu de la première réunion. Et les prochaines étapes :
-
S’approprier le vocabulaire ‹ du savoir & connaissances ›
-
Commencer la rédaction de succintes définitions ?
-
License CC-BY-SA
-
-
Ecrire un guide et des fiches pratique pour tenter de découpler la notion de l’outil (et critiquer le rendu, voir plus bas)
-
License CC-BY-SA
-
Ecrire un guide pour ‹ Je veux faire une visio ›
-
Ecrire une fiche (très?) pratique pour ‹ Je veux utiliser jitsi ›
-
Ecrire une fiche (très?) pratique pour ‹ Je veux utiliser bbb (BigBlueButton) ›
-
Prendre du recul et critiquer la documentation produite ; tenter de nourrir les réflexions suivantes :
-
Définir des cas d’usage de la base de connaissance ?
- Ateliers pratiques
- Approche culturel
- Apprentissage
- Approfondissement
- ‹ Auto › usage
- … ?
-
Tenter de définir quelques formalismes ?
- Des documents
- Guide de présentation
- Fiche pratique
- Fiche très pratique
- Documentation usage logiciel
- Histoire / Narration ?
- Du contenu
- Traduction de certains mots, terme
- S’attacher à l’usage des termes pour faire la langue
- Narratif
- Des documents
-
Outils / Pas outils?
-
Licenses
1 « J'aime »
Deuxième réunion concernant la documentation ce Jeudi 4/5 à 20H, plus d’infos sur ce pad . Avis aux amateurs 
Ordre Du Jour (ODJ)
-
Présentation / Tour de table | 
5-10min -
Point d’avancement sur les premières rédactions de doc’ | 5min / participant -
Critique de la documentation produite et bouclage sur la théorie
-
rédaction collective de la page du GT : objectifs et plan d’action (exemple GT) | 30-60min
-
Conclusion / Tour de table | 0-10min
Et de premiers travaux sur la documentation des logiciels de visio :
- la visio CryptPad
- bbb CryptPad
- inspirés (ctrl+c ctrl+v) de Comparatif fonctionnel des outils de visioconférences opensource - Arawa Utiliser BigBlueButton
1 « J'aime »
Bonjour !
Je vous attends dans le salon pour la réunion de ce soir
@GautGaut @reminec @plabuse @fabrice61
Hello !
Désolé je vous ai posé un lapin hier soir, j’ai été retenu par le boulot, très tard dans la soirée…
Je vais consulter le CR !
A bientôt.
(j’ai update le message de depart avec le lien vers le code de notre doc, celle ci est maintenant libre)
1 « J'aime »
J’ai animé un atelier dimanche au camp CHATONS pour discuter de la documentation utilisateur.ices. Un constat a été fait que de la très bonne doc’ existait pour la plupart des fonctionnalités et outils de base, mais que souvent les fonctionnalités avancées étaient absentes des documentations. Et que les bonnes doc’ étaient éparpillées sur de nombreux wikis. Le compte-rendu détaillé de l’atelier du camp devrait suivre.
En attendant la proposition d’action qui en est sortie est la suivante :
- Structurer l’état de l’art sur la documentation utilisateur
- Lister les services
- Lister les fonctionnalités de chaque service
- Edition collaborative d’un tableur qui recense les meilleures documentations utilisateur sur les outils/services principaux dans le collectif et leurs fonctionnalités
- Vote pour déterminer les outils et fonctionnalités sur lesquels prioriser un travail collaboratif de rédaction de doc’
Durant la deuxième heure de l’atelier, on a commencé à travailler et on appelle donc à continuer ce travail collaborativement en ligne. Vous pouvez participer à la rédaction de ce tableur collaboratif :
- En ajoutant des liens vers de bons tutoriels (colonnes) de découverte de l’utilisation d’un outil que vous connaissez
- En ajoutant détaillant un service et ses fonctionnalités (ligne). En particulier une fonctionnalité pour laquelle vous ne connaissez pas de doc’
Une réunion aura lieu pour travailler sur le document et définir la procédure pour la phase de vote à la rentrée après la prochaine réunion sur la formation. Il faudra qu’on décide si un ou deux groupes de travail sont nécessaires pour traiter les thématiques documentation utilisateur et formation « un peu technique » des bénévoles. En tous cas il faudra sans doute un « gros tuyau » (une forte collaboration) entre ces deux travaux.
3 « J'aime »
Bonjour,
Je n’aurai pas beaucoup de temps pour les mois à venir pour participer aux ateliers sur la documentation, donc je me permets d’apporter des éléments de réflexion supplémentaires sur ce sujet en présentant notre documentation ici (si ça peut aider) :
https://docs.lacontrevoie.fr/
Structure
Elle est divisée en quatre sections :
- Activités de sensibilisation : on tient un registre de nos activités, et on documente nos confs, nos ateliers et la tenue de nos stands ;
- Technique : toute la documentation technique, de notre infra en général, de nos services et de leurs dépendances (stockage, monitoring, backups, protocoles spécifiques…), les routines (cron), les scripts un peu personnalisés / faits maison et les guides de maintenance ;
- Administratif [WIP] : comment on réalise notre compta, comment on demande nos agréments / subventions, comment on rédige des réponses à nos emails, comment on rédige notre rapport moral / financier, nos procès verbaux, comment on prend des décisions collectives…
- Communication [WIP] : des informations sur nos outils de communication physiques (matériel de stand, tee-shirts…) et numériques (matrix, réseaux sociaux).
Nous n’avons pas de documentation utilisateur·ice au-delà des pages de présentation de nos services.
L’objectif de cette documentation est tantôt de servir de guide pas-à-pas, tantôt de référence pour nos membres bénévoles ou pour des personnes extérieures qui souhaiteraient se renseigner sur nos pratiques internes, selon les sections. Les objectifs de chaque section sont explicités sur la page d’accueil de la section.
Niveau backend
C’est un site statique (Zola), le code est là. Pour l’édition, on intègre un bouton « éditer cette page » sur chaque page de la doc qui redirige vers la page d’édition de notre instance Gitea.
On n’a rien inventé : on fait tout pareil que Framasoft (pour leur doc technique et de participation, notamment) sauf qu’iels utilisent GitLab à la place, grâce au logiciel HonKit basé sur Gitbook.
L’édition n’est pas aussi intuitive que sur Bookstack ou Dokuwiki, mais reste quand même globalement accessible pour des personnes non-initiées :
- Gitea intègre un éditeur qui rend la modification du markdown plutôt facile ;
- Zola intègre un système de macros/shortcodes pour insérer des bouts de HTML sans avoir à en écrire (exemple :
{% message("todo") %}pour afficher un bloc formaté indiquant qu’une page est en construction) ; - pas besoin de ligne de commande : une fois la page éditée dans l’interface web, la PR est automatiquement créée lors de la mise à jour de la page.
On a choisi cette solution pour sa légèreté : on s’évite un moteur de rendu + une base de données, et toutes les pages sont dans un dépôt au format markdown.
3 « J'aime »
Salut à tous,
je ne me risquerais pas à promettre une forte participation, par contre, en raison d’une malédiction qui me suit depuis de très nombreuses années, je vois immédiatement une très grande part des erreurs typographiques, orthographe et accords de grammaire.
Je propose donc une contribution de relecteur/correcteur de ces aspects, et ainsi alléger la tâche de celles et ceux qui ont la malédiction inverse!
2 « J'aime »
Hello, je souffre de la même malédiction, je peux donc contribuer de la même façon si besoin
3 « J'aime »