Différences entre versions de « Aide MHK »

De wikilab
Ligne 7 : Ligne 7 :
 
Le formulaire contient toutes les informations qui résument le projet et qui apparaîtront dans l'infobox, l'encart en haut à droite de la page .
 
Le formulaire contient toutes les informations qui résument le projet et qui apparaîtront dans l'infobox, l'encart en haut à droite de la page .
  
Pour les champs suivants: Porteur de projet, Contributeur, Fabmanager, Animateur, utiliser le nom d'utilisateur de la personne sur le wiki (pour celles qui ont un compte),
+
Pour les champs suivants: Porteur de projet, Contributeur, Fabmanager, Animateur, utiliser le nom d'utilisateur de la personne sur le wiki (pour celles qui ont un compte)
 +
 
 +
 
 +
Une fois les informations remplies, cliquer sur enregistrer en bas du formulaire
 +
[[File:enreg_formulaire.png|700px|vignette|left|bouton Enregistrer en bas du formulaire]]
 +
 
 +
 
 +
== Documentation type d'un projet ==
 +
Voici les éléments principaux requis pour la documentation de projets une fois votre page créée. Ce modèle est automatiquement intégré lorsque vous créez la page avec la méthode simplifiée.
 +
 
 +
Attention pour que votre page apparaisse dans les rubriques des menus, assurez-vous de toujours garder en bas de page les catégories.
 +
 
 +
* Description du projet (quel est l'objectif du projet, à quel besoin il répond?)
 +
* Cahier des charges prenant en compte la faisabilité / les contraintes
 +
* Analyse de l'existant (liens vers des systèmes existants et dire en quoi l'existant ne répond pas au besoin : trop cher, pas adapté etc ...)
 +
* Durée totale réelle de la fabrication du prototype
 +
* Équipe (Ajouter le porteur de projet et les contributeurs)
 +
* Matériel nécessaire
 +
* Outils nécessaires
 +
* Compétences/techniques nécessaires
 +
* Coût avec le plus de détails possible élément par élément (et sourcer les fournisseurs de préférence)
 +
* Documenter tout le processus de création étape par étape, en uploadant les fichiers sources
 +
* Journal de bord : le journal de bord permet de suivre les avancées du projet, à chaque nouveau rendez-vous on écrit un petit compte-rendu, et on ajoute les fichiers source (dessins 2D, 3D, code etc ..)
 +
* Intégrer la ou les  catégories auxquels le projet appartient. Tous les projets appartiennent à la catégorie Projets. Pour l'affilier il suffit d'intégrer en bas de page cette ligne.
 +
<nowiki>[[Category:Projets]]</nowiki>
 +
* Spécifier l'état d'avancement du projet (Concept,En cours, Réalisé): Ajouter la catégorie correspondante en fin de page. ne pas oublier de modifier cette catégorie quand l'état d'avancement du projet change.
 +
<nowiki>[[Category:En cours]]</nowiki>
 +
*Modèle de page :
 +
Pour créer une page basée sur le modèle type de documentation de projet, insérer dans la page
 +
<nowiki>{{subst:Projet}} </nowiki>
 +
 
 +
Tout les chapitres seront créés automatiquement avec un sommaire associé
  
 
==Aide à l'édition :modifier, enregistrer==
 
==Aide à l'édition :modifier, enregistrer==

Version du 8 novembre 2022 à 18:28

Création d'une page : Projet, Tutoriel ou support pédagogique

https://wikilab.myhumankit.org/index.php?title=Contribuer_%C3%A0_la_documentation


Informations à remplir dans le formulaire

Le formulaire contient toutes les informations qui résument le projet et qui apparaîtront dans l'infobox, l'encart en haut à droite de la page .

Pour les champs suivants: Porteur de projet, Contributeur, Fabmanager, Animateur, utiliser le nom d'utilisateur de la personne sur le wiki (pour celles qui ont un compte)


Une fois les informations remplies, cliquer sur enregistrer en bas du formulaire

bouton Enregistrer en bas du formulaire


Documentation type d'un projet

Voici les éléments principaux requis pour la documentation de projets une fois votre page créée. Ce modèle est automatiquement intégré lorsque vous créez la page avec la méthode simplifiée.

Attention pour que votre page apparaisse dans les rubriques des menus, assurez-vous de toujours garder en bas de page les catégories.

  • Description du projet (quel est l'objectif du projet, à quel besoin il répond?)
  • Cahier des charges prenant en compte la faisabilité / les contraintes
  • Analyse de l'existant (liens vers des systèmes existants et dire en quoi l'existant ne répond pas au besoin : trop cher, pas adapté etc ...)
  • Durée totale réelle de la fabrication du prototype
  • Équipe (Ajouter le porteur de projet et les contributeurs)
  • Matériel nécessaire
  • Outils nécessaires
  • Compétences/techniques nécessaires
  • Coût avec le plus de détails possible élément par élément (et sourcer les fournisseurs de préférence)
  • Documenter tout le processus de création étape par étape, en uploadant les fichiers sources
  • Journal de bord : le journal de bord permet de suivre les avancées du projet, à chaque nouveau rendez-vous on écrit un petit compte-rendu, et on ajoute les fichiers source (dessins 2D, 3D, code etc ..)
  • Intégrer la ou les catégories auxquels le projet appartient. Tous les projets appartiennent à la catégorie Projets. Pour l'affilier il suffit d'intégrer en bas de page cette ligne.
[[Category:Projets]]
  • Spécifier l'état d'avancement du projet (Concept,En cours, Réalisé): Ajouter la catégorie correspondante en fin de page. ne pas oublier de modifier cette catégorie quand l'état d'avancement du projet change.
[[Category:En cours]]
  • Modèle de page :

Pour créer une page basée sur le modèle type de documentation de projet, insérer dans la page

{{subst:Projet}} 

Tout les chapitres seront créés automatiquement avec un sommaire associé

Aide à l'édition :modifier, enregistrer

Pour éditer la page, soit cliquer sur le bouton modifier en haut à droite de la page pour éditer toute la page soit cliquer sur le bouton Modifier visible à côté de chaque chapitre pour éditer uniquement cette section.

Bouton modifier pour éditer la page entière en haut à droite de la page
Bouton modifier pour éditer une section de page


Pour sauver les modifications cliquer sur le bouton "Enregistrer les modifications" tout en bas de la page

Texte pour intégrer l'image qui apparait là où le curseur de la souris était placé avant de cliquer sur "Insérer en tant qu'image"


Formatage du texte

Pour formater le texte (en gras, italique, faire des titres, des listes, tableaux etc ..), deux solutions, soit écrire directement en wikicode grâce à l'aide de l'éditeur de texte, soit aller dans le menu avancé de l'éditeur de texte pour sélectionner le formatage voulu une fois le texte sélectionné.


Option 1: Écrire en wikicode avec l'aide de l'éditeur

Cliquer sur la flèche Aide dans l'éditeur de texte pour afficher l'aide
Vue de l'aide à l'édition ouverte dans l'éditeur de texte. A gauche de l'éditeur il y a plusieurs onglets pour accéder aux différentes pages de l'aide


Option 2: Utiliser l'onglet avancé de l'éditeur

Cliquer sur la flèche pour afficher le menu Avancé
Vue du menu Avancé ouvert. Sélectionner la partie du texte à mettre en forme et cliquer sur le formatage voulu (liste, titre, gras, italique etc..


Importer une ou des image(s)

IMPORTANT: redimensionner les images avant de les importer. Les images peuvent être redimensionnées à 700px de large, et ne doivent pas dépasser 200ko. L'extension de l'image doit être de type "jpg" ou "png".

  • Ouvrir votre dossier d'images dans l'explorateur de fichiers de l'ordinateur et sélectionner les images à importer (pour en sélectionner plusieurs , appuyer sur la touche Control)
Sélection des images


  • Faire glisser la sélection dans l'éditeur là où est indiqué "Glisser ici les fichiers"
  • Cliquer sur Téléverser tous les fichiers
Bouton téléverser tous les fichiers


  • Positionner le curseur de la souris à l'endroit où vous voulez que votre image apparaisse puis cliquer sur Insérer en tant qu'image
Lien insérer en tant qu'image


  • Vérifier que l'image a bien été ajoutée à l'emplacement du curseur, avec un texte de ce type : [[File:Inserer_en_tant_image.png]]
Texte d'intégration d'image apparu à l'emplacment du curseur de la souris après avoir cliquer sur lien insérer en tant qu'image


Configuration de l'intégration de l'image

Accessibilité : Il est préférable d'éviter l'usage de galeries car elles sont inacessibles pour les malvoyants. Il faut privilégier des images avec des légendes décrivant l'image.

Le format de vignette est donc idéal car il permet d'ajouter une légende sous l'image

Pour ajouter un paramètre on ajoute un pipe (trait vertical) pour chaque nouveau paramètre après le nom de l'image. L'ordre n'a pas d'importance à part le nom de l'image qui doit rester en première position


Exemple :

[[File:Televerser_fichiers.png|700px|vignette|gauche|Bouton téléverser tous les fichiers]]

Explications du wikicode entre les double crochets pour intégrer l'image.

  • File:Televerser_fichiers.png => Nom de l'image
  • 700px => largeur de l'image, qui change proportionnellement la hauteur. Pour choisir la bonne taille il faut se dire que l'image doit être "lisible" sans avoir à cliquer dessus pour l'agrandir.
  • vignette => Format encadré de l'image permettant d'ajouter une légende
  • gauche =>alignement de l'image (options possible: gauche, centre, droite)
  • Bouton téléverser tous les fichiers =>Légende (décrire précisément ce qu'on voit dans l'image, penser qu'un malvoyant s'en sert pour visualiser l'image)