User talk:Ikanot/Guide

Faire un nouveau tutoriel

Quelques principes utiles pour faire des tutoriels

Pas besoin de documenter tout documenter ! Privilégier les tutoriels qui expliquent :

des opérations enfouies dans des sous-menu / qui supposent beaucoup de clics. Ex: Indiquer les crédits pour une uMap
des fonctionnalités dont on ne peut pas deviner l'existence. Ex: on peut configurer les filtres du visualisateur de données
des choses que vous oubliez vous-même parfois / que vous avez mis du temps à comprendre. Ex: comment ajouter une image

Écrire le moins possible
- peu de texte + phrases courtes = traduction / mise à jour plus facile
Faire des tutoriels orientés "action"
- un tutoriel accompagne l'utilisateur pour réaliser une action précise (il guide pas à pas)
- il ne sert pas à décrire une fonctionnalité ou à "apprendre quelque chose" à l'utilisateur
Chaque tutoriel traite d'une action et d'une seule
- si c'est une action différente, c'est un tutoriel différent
- si vous éprouvez le besoin de diviser votre explication, vous pouvez probablement faire 2 tutoriels différents
Chaque tutoriel est autonome
- s'il faut lire un 2e tutoriel pour réaliser celui qu'on lit déjà, il y a un problème
Utiliser des titres descriptifs, facile à rechercher
- la question que va googler l'utilisateur = le titre du tutoriel (en général)
Relire et tester les tutoriels
- Vérifier qu'aucune étape n'a été sautée, même une étape minime
- Tester les tutoriels

Faire des captures de la version anglaise de uMap
- plus simple pour traduire les tutoriels
- exception : si l'image contient des informations que l'utilisateur doit lire, capturer dans la langue cible
Faire des captures réutilisables pour d'autres tutoriels
- facilite la maintenance / mise à jour / traduction des tutos
- ...mais moins pratique pour l'utilisateur final :(
Attention à la taille / poids des images'
- il y a un juste milieu entre "trop lourd" et "trop petit"
- 1200 ou 1500px de large, pour 300-700ko ça va

Mettre les tutoriels en sous page de /Guide
- Ex: FR:UMap/Guide/Mon tuto en français, UMap/Guide/My english tutorial
- Attention, l'URL est UMap, pas Umap
Categoriser les tutoriels et les images avec Category:UMap or Category:FR:UMap
- Sinon personne ne les retrouvera. Jamais. Surtout les images.