Contribuer à la documentation

Comment contribuer?

Pour contribuer à la documentation :

1. créez-vous un compte utilisateur sur wikilab
2. demander à un fabmanager de valider votre compte

Vous trouverez ici une page d'aide pour éditer votre page en adoptant les bonnes pratiques.

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

{{subst:projet}}

Equipe (Porteur de projet et contributeurs)

• Porteurs du projet :
• Concepteurs/contributeurs :
• Animateur (coordinateur du projet)
• Fabmanager référent
• Responsable de documentation

Journal de bord

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 "Voir le code source" 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.

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.