Différences entre versions de « Contribuer à la documentation »
De wikilab
| (26 versions intermédiaires par le même utilisateur non affichées) | |||
| Ligne 2 : | Ligne 2 : | ||
===Pour contribuer à la documentation=== | ===Pour contribuer à la documentation=== | ||
# créer 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éer une nouvelle page== |
| − | + | Se connecter pour pouvoir éditer! | |
| − | + | ||
| − | + | <onlyinclude> | |
| − | + | Un usager peut créer 5 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 [[Projets:Guide_doigt_clavier_Logitech_K360|(exemple)]] | |
| − | + | * 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 = documentation des réalisations produites pendant un atelier [[Formations:Askoria-BPJEPS-Morlaix|(exemple)]] | ||
| + | * Un événement = associer des pages projets à un événement [[Formations:Atelier_Mobilab_4_du_23_au_29_Novembre_2022|(exemple)]]. Le portfolio des projets sera automatiquement affiché sur cette page à partir du moment où la page projet est associée à la page de l'événement via le formulaire de l'infobox de la page Projet. | ||
| + | |||
| + | {| 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: 19%;"|[[Nouveau_projet|'''<span style="color:white">Créer un projet'''</span>]] | ||
| + | | style="width:1.25%;background-color:#A2A9B1;"| | ||
| + | | style="width: 19%;"|[[Nouveau_tutoriel|'''<span style="color:white">Créer un tutoriel'''</span>]] | ||
| + | | style="width:1.25%%;background-color:#A2A9B1;"| | ||
| + | | style="width: 19%;"|[[Nouveau_support_pédagogique|'''<span style="color:white">Créer un support pédagogique'''</span>]] | ||
| + | | style="width:1.25%%;background-color:#A2A9B1;"| | ||
| + | | style="width: 19%;"|[[Nouvel_atelier|'''<span style="color:white">Documenter un atelier'''</span>]] | ||
| + | | style="width:1.25%%;background-color:#A2A9B1;"| | ||
| + | | style="width: 19%;"|[[Nouvel_%C3%A9v%C3%A8nement|'''<span style="color:white">Créer un événement'''</span>]] | ||
| + | |} | ||
| + | </onlyinclude> | ||
===Editer sa page=== | ===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 |
| − | + | * Trouver de l'aide [[Aide_MHK|ici pour éditer votre page ]], également accessible dans le menu de gauche sous l'onglet "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. | + | * 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== | ||
| − | + | Redimensionner systématiquement les images (<200Ko) et optimiser la taille des fichiers importés (pdf ou autre) et ajouter une légende décrivant l'image | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ''' | + | Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons très très vivement à '''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.''' |
| − | |||
| − | |||
| − | |||
| − | + | De manière générale, ajouter les fichiers sources au format natif du programme utilisé pour le design 2D ou 3D afin qu'ils puissent être modifiés surtout s'il s'agit d'un logiciel libre, ET les formats standards type STL pour les fichiers 3D, SVG pour les fichiers vectoriels (etc ..) pour permettre l'interopérabilité des fichiers ,notamment quand le logiciel natif n'est pas libre (car tout le monde n'y a pas accès!). | |
| − | |||
| − | |||
| − | + | Il est bon également de compresser tous les fichiers sources dans un seul dossier compressé pour pourvoir récupérer l'ensemble des sources en un seul clic! | |
| − | |||
| − | + | Quand un projet démarre , on lui assigne la catégorie d'état d'avancement : En cours, via le formulaire | |
| − | + | Chaque page projet a deux onglets : Projets et Journal de bord. | |
| − | + | Lors de la création de page, il est nécessaire de remplir immédiatement les chapitres suivants : Description, cahier des charges | |
| − | + | Pour le reste les chapitres seront remplis uniquement une fois le prototype finalisé. | |
| − | |||
| − | |||
| − | |||
| − | + | Cependant tous les éléments (fichiers sources, schémas, photos, étapes de fabrications, comptes-redus de réunions etc, seront écrits dans Journal de bord. Une fois le prototype réalisé , il suffira de copier/coller les éléments finaux collectés sur la page Journal de bord sur la page Projet. | |
Version actuelle datée du 22 septembre 2023 à 12:45
Comment contribuer?
Pour contribuer à la documentation
- créer un compte utilisateur sur wikilab
- 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
Se connecter pour pouvoir éditer!
Un usager peut créer 5 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 = documentation des réalisations produites pendant un atelier (exemple)
- Un événement = associer des pages projets à un événement (exemple). Le portfolio des projets sera automatiquement affiché sur cette page à partir du moment où la page projet est associée à la page de l'événement via le formulaire de l'infobox de la page Projet.
| Créer un projet | Créer un tutoriel | Créer un support pédagogique | Documenter un atelier | Créer un événement |
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
- Trouver de l'aide 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
- 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
Redimensionner systématiquement les images (<200Ko) et optimiser la taille des fichiers importés (pdf ou autre) et ajouter une légende décrivant l'image
Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons très très vivement à 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.
De manière générale, ajouter les fichiers sources au format natif du programme utilisé pour le design 2D ou 3D afin qu'ils puissent être modifiés surtout s'il s'agit d'un logiciel libre, ET les formats standards type STL pour les fichiers 3D, SVG pour les fichiers vectoriels (etc ..) pour permettre l'interopérabilité des fichiers ,notamment quand le logiciel natif n'est pas libre (car tout le monde n'y a pas accès!).
Il est bon également de compresser tous les fichiers sources dans un seul dossier compressé pour pourvoir récupérer l'ensemble des sources en un seul clic!
Quand un projet démarre , on lui assigne la catégorie d'état d'avancement : En cours, via le formulaire
Chaque page projet a deux onglets : Projets et Journal de bord.
Lors de la création de page, il est nécessaire de remplir immédiatement les chapitres suivants : Description, cahier des charges
Pour le reste les chapitres seront remplis uniquement une fois le prototype finalisé.
Cependant tous les éléments (fichiers sources, schémas, photos, étapes de fabrications, comptes-redus de réunions etc, seront écrits dans Journal de bord. Une fois le prototype réalisé , il suffira de copier/coller les éléments finaux collectés sur la page Journal de bord sur la page Projet.
