Contribuer à la documentation

From wikilab
Jump to: navigation, search

Comment contribuer?

Pour contribuer à la documentation

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

Créer une nouvelle page Projet

  1. créer la page en ajoutant le nom du projet dans la zone de texte puis cliquer sur le bouton pour valider. Ne jamais laisser d'espace dans le nom du projet, il faut les remplacer par des underscores (ou tirets du bas)
  2. Cette page sera créé automatiquement avec un modèle regroupant toutes les informations à remplir pour constituer une documentation complète
  3. Valider la création en cliquant sur "Enregistrer" en bas de la page"


Editer sa page

  • Cliquer sur "Modifier" en haut à droite
  • 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.