Suggestion 0027

De Fab Labs Québec
Aller à :navigation, rechercher

Ouverture : 2019-06-18

Type : Fonctionnalité wiki

Priorité : 2 - Normal

Proposeur :
Marc Lemaire
Guillaume Coulombe

État de suivi :

 4 - Résolu 


Nom de la suggestion

Ajout d'instructions et manuel d'opération aux pages Machines et Modèle de machines

Justificatif

Mieux une machine est utilisée, moins elle casse. Plus les instructions d'utilisation d'une machine sont claires, mieux elle est utilisée. Les documents externes sur des services "gratuits" sont parfois jolis mais on risque de les perdre. On aimerait pouvoir lier les guides d'utilisation maison à la page d'une machine (dans son lab) et ensuite par requête à Modèle de machine. De même, les manuels d'utilisateurs des machines dans la page du modèle par URL (fait). Certains fichiers de travail pourraient se retrouver sur Nextcloud, toutefois les .pdf serait probablement mieux dans le wiki carrément.

Réponse au proposeur

Comme on a actuellement des problèmes avec les fonctions d'import de fichier au formulaire, je suggère que vous importiez ce genre de documents manuellement depuis le lien "Importer un fichier" (en bas de toutes les pages du wiki) pour ensuite le lier dans le champs notes avec la syntaxe que j'ai indiqué en notes de cette suggestion. Une fois qu'on aura mis à jour les wikis vers la prochaine version LTS (Long Term Support), probablement en été 2020, on pourra revoir.

MAJ 9 mars 2021 : Finalement on a implémenté une fonction pour intégrer les manuels d'opération/maintenance des machines dans le wiki. Depuis une page d'atelier, on peut maintenant voir un onglet "Guides" où l'on peut observer les guides disponibles pour chaque modèle de machine et soit cliquer sur un bouton "Créer un guide" (pour ajouter un nouveau guide créé par l'atelier) ou "Utiliser" (pour indiquer qu'on utilise le guide d'un autre atelier). Les guides ont leur propre page wiki qui documente les méta-données et un champs de formulaire pour importer le fichier PDF lui-même. Les pages de guides ainsi que le fichier PDF seront automatiquement nommées si elles sont ajoutées depuis le bouton "Créer un guide". Alternativement, pour nommer le guide manuellement, vous pouvez afficher la section "Créer un guide manuellement" en bas du tableau des guides ou à la page de perspective https://wiki.fablabs.quebec/index.php/Guides .

Suivis

Date Par Notes
2020/02/28 03:11:09 PM Guillaume Ici, pour le moment, sii on mettait un lien externe vers la page du manufacturier du manuel de la machine, on gagnerait sans doute. Y'a possibilité que le lien se brise un jour, y'aurait peut-être un bot qui pourrait valider périodiquement aussi les liens externes? On pourrait sensible procéder de la même façon que dans le modèle projet, quitte à aussi ajouter une autre section pour d'autres outils d'aide à l'utilisation de ce modèle d'équipement?
2020/02/28 03:23:33 PM Yoann Ochietti Il y à déjà un champs d'url externe pour le manuel.

Effectivement on pourrait rouler un robot pour valider les liens externes, mais c'est pas trop simple à setup/maintenir.

C'est précisément la mécanique comme dans les projets (import de fichiers au formulaire) qui est brisée. Mais effectivement, c'est vraiment comme ça le mieux je crois si on veut garder les fichiers au wiki. Ça vaudrait peut-être la peine d'attendre pour pas avoir à reswitcher dans qq mois.

Ceci dit, MW c'est pas le meilleur trucs pour gérer des gros fichiers (des pdfs c'est gros!), surtout s'ils vont changer beaucoup. On est peut-être mieux de setup des liens externes vers NC, ou juste tolérer que les liens meurt et laisser les usagers garder ça à jour. C'est un wiki après tout!

2020/02/28 03:40:13 PM Guillaume Alors attendons...
2021/02/22 04:40:01 PM Guillaume Pour le partage des guides maison :
  • Si on l'entre à la page d'une machine,
    • comme ça on distingue facilement le Fab Lab qui l'a consu et on ajoute une colonne dans le tableau pour ajouter un lien où Guide pointe vers la page du guide de la machine.
    • possible ensuite d'ajouter une colonne dans le tableau des machines d'un modèle ou type d'équipement pour voir les guides maison disponibles.
    • un fab lab qui se met à utiliser un guide pourrait dire dans une page de ses machine qu'il se sert du guide de l'autre.
      • il pourrait aussi être invité à Suivre le fichier pour savoir si y'a une mise à jour
    • si un fab lab a 5 machines pareil, on imagine que l'écrire à une seule machine suffise.
    • y'aura peut-être à penser à un peu de méta-données sur le guide?
  • Si on l'entre dans la page d'un modèle de machine, il faudra faire en sorte qu'il apparaisse dans la page du fab lab qui l'a produit - idéalement de ceux qui l'utilisent. Me semble que cette mécanique serait plutôt difficile.
  • Dans tous les cas, une invitation au nom clair de document est à prévoir qq part...
2021/02/24 10:18:55 AM Yoann Ochietti Mes réponses :

Pour le partage des guides maison :

  • Si on l'entre à la page d'une machine,
    • comme ça on distingue facilement le Fab Lab qui l'a conçu et on ajoute une colonne dans le tableau pour ajouter un lien où Guide pointe vers la page du guide de la machine.
      • Yoann : Oui, facile.
    • possible ensuite d'ajouter une colonne dans le tableau des machines d'un modèle ou type d'équipement pour voir les guides maison disponibles.
      • Yoann : Oui, facile.
    • un fab lab qui se met à utiliser un guide pourrait dire dans une page de ses machine qu'il se sert du guide de l'autre.
      • Yoann : Possible, mais ça serait tricky de différencier les deux types d'usage (guide maison personnel vs guide maison d'un autre lab). Si on peut juste proposer les guides existants dans le champs "Guide maison" et laisser le nom du guide (e.g. "Guide de la Trotex Speedy 300 par Échofab") faire l'attribution au lab ça resterait simple à développer. Si on veut avoir un tag sémantique pour le créateur du guide ça serait plus de travail, probablement avec des objets internes ou un champs séparé (e.g. "Guide maison d'autrui", pas full élégant...)
      • il pourrait aussi être invité à Suivre le fichier pour savoir si y'a une mise à jour
        • Yoann : Oui, facile à ajouter en instruction au champs de formulaire.
    • si un fab lab a 5 machines pareil, on imagine que l'écrire à une seule machine suffise.
      • Yoann : Dans le meilleur des mondes les gens utiliserait le bouton "j'en ai une autre comme ça!" après avoir créé la première machine et lui avoir attribué le guide maison, mais clairement que ça couvre pas tout les scénarios (e.g. si un guide est ajouté après la création initiale des machines identiques). Je vais pouvoir faire des passes-passes de requêtes pour aller voir si un guide pour une machine du même modèle est déjà utilisé dans le même lab pour populer les tableaux, mais je préviens que c'est pas mal de job à écrire des requêtes et ça rend notre structure sémantique un peu moins cohérente/intégrée, mais c'est probablement un sacrifice valable si on veut vraiment éviter la job désagréable aux usagers de copy-paste le manuel dans chaque machine... Voir prochain point pour une alternative.
    • y'aura peut-être à penser à un peu de méta-données sur le guide?
      • Yoann : Peut-être on pourrait les ajouter comme pages dans ce cas pour éviter les objets internes? Ça pourrait être une réponse au problème soulevé dans le point précédent concernant la cohérence du data. Dans la page du manuel maison tu pourrait lister les ateliers qui m'utilisent et les modèles de machines qui m'utilisent (s'il peut y en avoir plusieurs... ferait du sens pour les différents modèles d'une même marque). Comme ça les machines uniques ont pas besoins d'avoir le manuel d'indiqué. Dans ce cas, on mettrait probablement un bouton "Ajouter un manuel maison" dans le tableau des machines d'un atelier et dans la page du modèle de machine. Il faudrait aussi une manière de suggérer les guides existants comme l'ajout ne se ferais pas via un champs de formulaire avec du autocomplete, on pourrait considérer pour ça de faire qqchose de similaire a ce qu'on avait fait dans VDJ pour l'ajout de morceau (query form pour chercher parmi les guides existants).
      • Yoann : Pour ce qui est des méta-données qu'on voudrait, je dresse une liste de candidats : Auteur(s) (Personne), Date de création, Atelier/organisation créatrice, S applique au modèle(s), Enjeux (?), Date de modif (par une requête, utile pour savoir si le guide est à jour), Logiciels utilisés, Pour le type d équipement, Langue(s)
  • Si on l'entre dans la page d'un modèle de machine, il faudra faire en sorte qu'il apparaisse dans la page du fab lab qui l'a produit - idéalement de ceux qui l'utilisent. Me semble que cette mécanique serait plutôt difficile.
    • Yoann : Si on veut différencier les créateurs des utilisateurs, ça prendrait des objet interne. Je crois pas qu'il y ait de problème après ça à juste requêter le lab inscrit comme créateur du guide pour l'afficher dans la page du lab créateur, mais tu as raison que pour les labs utilisateurs ça devient difficile d'avoir un beau processus pour déclarer une utilisation de guide. Il faudrait que le créateur des pages de machines de l'atelier aille dans la page du modèle s'ajouter dans une liste d'utilisateurs du guide maison, mais comme il ne cré pas la page de modèle c'est pas vraiment raisonnable de penser qu'il se rendrait au formulaire Modèle de machine. Alternativement il pourrait y avoir une section "Guides maisons utilisés" à la page du lab où t'indiquerait le modèle de machine et le guide dans une liste d'objets internes ("Modèle de machine" avec autocomplete sur les modèles de machines utilisés et ensuite "Guide maison utilisé" avec un autocomplete sur les guides existants ajoutés au modèle et une suggestion d'aller ajouter un guide dans la page du modèle si vous en avez construit un dans votre lab).
  • Dans tous les cas, une invitation au nom clair de document est à prévoir qq part...
    • Yoann : C'est difficile à forcer... Idéalement les tags sémantiques et le contexte suffiraitent à décrire/identifier le document, mais on peut suggérer un naming scheme de ton choix... e.g. "Guide pour <Modèle> par <Atelier>"


Autres notes

Dans la boite à droite de la page, on pourrait retrouver :

Manuel du fabricant : url...... (pê faire un beau lien joli?)

Fiches d'aide

Utilisation
  • docu 1
Entretien
  • docu 2
  • docu 3


Syntaxe pour les fichier en notes :

[[Fichier:Nom_du_fichier.pdf]]