Différences entre versions de « Contribuer à la documentation »

De wikilab
(14 versions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
 
==Comment contribuer?==
 
==Comment contribuer?==
Pour contribuer à la documentation :
+
===Pour contribuer à la documentation===
# créez-vous un compte utilisateur sur wikilab  
+
# créer un compte utilisateur sur wikilab  
# demander à un fabmanager de valider votre compte  
+
# demander à un fabmanager de valider votre compte et de vous associer les droits selon le type de contenu que vous souhaitez éditer.
# créez votre page
 
<inputbox>
 
type=create
 
break=no
 
prefix=Projets:
 
labeltext=Look for:
 
buttonlabel=Créer nouveau projet
 
preloadparams[]={{Template:Projet}}
 
</inputbox>
 
  
Editer sa page :
+
==Créer une nouvelle page==
*Avant d'ajouter du contenu à votre page, ajouter simplement cette ligne pour générer automatiquement le modèle de la page que vous pourrez ensuite éditer et modifier
+
Un usager peut créer 4 types de contenus sur ce wiki et il doit disposer des droits en édition sur l'espace de nom associé au contenu (Projets, Ressources, Supports_peda ou Formations):
<nowiki>{{subst:projet}}</nowiki>
+
* Un projet = étapes de fabrication pour reproduire un prototype [[Projets:Guide_doigt_clavier_Logitech_K360|(exemple)]]
*Trouver de l'aide [[Aide_MHK|ici pour éditer votre page ]] en adoptant les bonnes pratiques, également accessible dans le menu de gauche sous l'onglet "Aide MHK"
+
* Un tutoriel = une aide pas à pas pour s'emparer d'une technique [[Ressources:Communication_Bluetooth_HC_05|(exemple)]]
 +
* Un support pédagogique = un support pour animer un atelier [[Supports_peda:Lecteur_MP3_tactile|(exemple)]]
 +
* Un atelier = documentaton des réalisations produites pendant un atelier [[Formations:Askoria-BPJEPS-Morlaix|(exemple)]]
  
 +
{| class="wikitable" style="width: 100%;background-color:#3D6999;color:white;text-align:center;font-size:18px;border-style: solid; border-width: 20px;padding:20px;"
 +
| style="width: 25%;"|[[Nouveau_projet|'''<span style="color:white">Créer un projet'''</span>]]
 +
| style="width:2%;background-color:#A2A9B1;"|
 +
| style="width: 25%;"|[[Nouveau_tutoriel|'''<span style="color:white">Créer un tutoriel'''</span>]]
 +
| style="width:2%;background-color:#A2A9B1;"|
 +
| style="width: 25%;"|[[Nouveau_support_pédagogique|'''<span style="color:white">Créer un support pédagogique'''</span>]]
 +
| style="width:2%;background-color:#A2A9B1;"|
 +
| style="width: 25%;"|[[Nouvel_atelier|'''<span style="color:white">Documenter un atelier'''</span>]]
 +
|}
  
 +
===Editer sa page===
 +
* Cliquer sur "Éditer avec formulaire" pour éditer le cartouche du projet
  
Le code utilisé s'appelle le wikicode (language utilisé pour wikipedia, basé sur le langage Markdown), il est simple à utiliser et vous trouverez toutes les manipulations d'édition basique sur la page [[Aide MHK|Aide MHK]]
+
* Cliquer sur "Modifier" en haut à droite pour éditer le contenu de la page
  
Si vous êtes sur une page vous pouvez visualiser le code source sur l'onglet "Voir le code source" en haut à droite de la page.
+
* Trouver de l'aide [[Aide_MHK|ici pour éditer votre page ]], également accessible dans le menu de gauche sous l'onglet "Aide MHK"
 +
 
 +
* Le code utilisé s'appelle le wikicode (language utilisé pour wikipedia, basé sur le langage Markdown), il est simple à utiliser et vous trouverez toutes les manipulations d'édition basique sur la page [[Aide MHK|Aide MHK]]
 +
 
 +
* Si vous êtes sur une page vous pouvez visualiser le code source sur l'onglet "Modifier" (en étant logué) ou "Voir le code source" (sans être logué) en haut à droite de la page.
  
 
==Les bonnes pratiques==
 
==Les bonnes pratiques==
 
Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons fortement à '''ajouter les fichiers source de Fritzing pour les schémas (et pas uniquement les images) ce qui permet aux malvoyants de pouvoir rouvrir le fichier et de le visualiser avec contraste.'''
 
Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons fortement à '''ajouter les fichiers source de Fritzing pour les schémas (et pas uniquement les images) ce qui permet aux malvoyants de pouvoir rouvrir le fichier et de le visualiser avec contraste.'''
 
==Comprendre les outils de gestion de projet==
 
Pour ton projet, tu vas avoir besoin de te créer un compte sur les plateformes suivantes :
 
 
===Création de comptes===
 
'''Geslab''' : https://dev.humanlab.me/login/?action=register
 
Va ensuite dans ton mail cliquer sur le message de validation de compte. Quand le mot de passe est généré, bien le noter avant de valider.
 
 
'''Wikilab''':http://wikilab.myhumankit.org/index.php?title=Special:CreateAccount&returnto=Main+Page
 
Important:Notes et conserves bien précieusement l'email utilisé, le nom d'utilisateur (login) et le mot de passe !!
 
Une fois ton comptes créé envoies-moi par mail ton nom d'utilisateur (login) afin que je t'attribue des droits d'édition du wiki.
 
 
'''Framateam''' :https://framateam.org/login Une fois ton comptés créé, envoies un mail au fabmanager référent de ton projet pour qu'il t'invite sur le canal de discussion de ton projet
 
 
===Présentation des outils===
 
Le '''Geslab''' est le portfolio des projets du Humanlab avec tous les liens vers la documentation.
 
 
Le '''WikiLab''' est une plateforme de documentation collaborative qui permet à chacun de prendre des notes sur les avancées du projet et de le documenter.
 
 
Le '''Framateam''' est un canal de discussion qui permet à l'équipe d'échanger autour du projet, d'y déposer des photos, des liens, des pdf, et ainsi de pouvoir retrouver tout ces éléments à un seul endroit lors de la documentation du projet sur le wiki.
 
 
===Utilisation des outils selon les rôles===
 
 
Les '''contributeurs''' mettent sur Framateam les photos, liens, notes.
 
 
Le '''responsable de doc''' récupère les contenus sur Framateam et l'intègre sur la page wiki.(wikilab)
 
 
Le '''porteur de projet''' (ou fabmanager si besoin) assigne les contributeurs au projet dans le Geslab et ajoute les liens vers doc : wiki/thingiverse/github etc ..
 
 
L''''animateur''' fait le suivi de projet :
 
 
*grâce aux échanges sur framateam
 
*identifie les compétences manquantes (Geslab)
 
*fait une demande de commandes de matériel au fabmanager référent avec les liens vers les références précises (hors USA)
 
 
Le '''fabmanager''' est le référent pour le projet et s'appuie sur tous les outils pour vérifier le bon déroulement du projet.
 

Version du 28 juin 2022 à 15:21

Comment contribuer?

Pour contribuer à la documentation

  1. créer un compte utilisateur sur wikilab
  2. demander à un fabmanager de valider votre compte et de vous associer les droits selon le type de contenu que vous souhaitez éditer.

Créer une nouvelle page

Un usager peut créer 4 types de contenus sur ce wiki et il doit disposer des droits en édition sur l'espace de nom associé au contenu (Projets, Ressources, Supports_peda ou Formations):

  • Un projet = étapes de fabrication pour reproduire un prototype (exemple)
  • Un tutoriel = une aide pas à pas pour s'emparer d'une technique (exemple)
  • Un support pédagogique = un support pour animer un atelier (exemple)
  • Un atelier = documentaton des réalisations produites pendant un atelier (exemple)
Créer un projet Créer un tutoriel Créer un support pédagogique Documenter un atelier

Editer sa page

  • Cliquer sur "Éditer avec formulaire" pour éditer le cartouche du projet
  • Cliquer sur "Modifier" en haut à droite pour éditer le contenu de la page
  • Le code utilisé s'appelle le wikicode (language utilisé pour wikipedia, basé sur le langage Markdown), il est simple à utiliser et vous trouverez toutes les manipulations d'édition basique sur la page Aide MHK
  • Si vous êtes sur une page vous pouvez visualiser le code source sur l'onglet "Modifier" (en étant logué) ou "Voir le code source" (sans être logué) en haut à droite de la page.

Les bonnes pratiques

Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons fortement à ajouter les fichiers source de Fritzing pour les schémas (et pas uniquement les images) ce qui permet aux malvoyants de pouvoir rouvrir le fichier et de le visualiser avec contraste.