๐ FICHE DE COURS รLรVEโ๏ธ
"Documentation Utilisateur ยท Guides ยท Tutoriels"โ๏ธ
Version 1.0 โ BTS SIO SISR โ Annรฉe 1 โ Semaine 18
๐ฏ Compรฉtences Travaillรฉesโ๏ธ
| Code | Compรฉtence |
|---|---|
| B1.5 | Mettre ร disposition un service informatique |
| B1.6 | Accompagner les utilisateurs dans l'appropriation d'un service |
PARTIE I โ Documentation Technique vs Utilisateurโ๏ธ
I.A. Les Deux Types de Documentationโ๏ธ
๐ Texte
DOCUMENTATION TECHNIQUE
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Public : Techniciens, administrateurs IT
Objectif : Installer, configurer, maintenir un systรจme
Langage : Technique, prรฉcis, avec jargon IT
Contenu : Procรฉdures dรฉtaillรฉes, commandes, configurations
Exemple :
"Installation de GLPI sur Ubuntu Server 22.04 avec Apache 2.4,
PHP 8.1 et MariaDB 10.6. Configuration du VirtualHost avec
DocumentRoot /var/www/glpi/public et activation du module
rewrite pour la rรฉรฉcriture d'URL."
DOCUMENTATION UTILISATEUR
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Public : Utilisateurs finaux (employรฉs, non-techniciens)
Objectif : Utiliser un service au quotidien
Langage : Simple, accessible, sans jargon
Contenu : Actions essentielles, captures d'รฉcran, FAQ
Exemple :
"Comment crรฉer un ticket de support ?
1. Allez sur http://support.entreprise.fr
2. Cliquez sur le bouton vert 'Nouveau ticket'
3. Remplissez le formulaire
4. Cliquez sur 'Envoyer'"
I.B. Rรจgles de Rรฉdaction Utilisateurโ๏ธ
โ UTILISER UN LANGAGE SIMPLE
๐ Texte
โ MAUVAIS (trop technique)
"Authentifiez-vous sur l'interface GLPI en saisissant vos
credentials LDAP dans le formulaire d'authentification."
โ
BON (simple et direct)
"Connectez-vous avec votre identifiant et mot de passe habituels."
โก รTRE CONCRET ET DIRECT
๐ Texte
โ MAUVAIS (abstrait)
"Il est possible de gรฉnรฉrer une demande d'assistance via
le systรจme de ticketing intรฉgrรฉ."
โ
BON (concret)
"Pour demander de l'aide, crรฉez un ticket en 3 clics."
โข UNE ACTION = UNE PHRASE COURTE
๐ Texte
โ MAUVAIS (phrase longue)
"Aprรจs avoir ouvert votre navigateur web et tapรฉ l'adresse du
support dans la barre d'adresse, vous devrez cliquer sur le
bouton de connexion situรฉ en haut ร droite de la page d'accueil."
โ
BON (รฉtapes numรฉrotรฉes)
1. Ouvrez votre navigateur
2. Allez sur http://support.entreprise.fr
3. Cliquez sur "Connexion" en haut ร droite
โฃ UTILISER DES CAPTURES D'รCRAN ANNOTรES
Un bon guide utilisateur comporte au moins une capture par รฉtape importante.
๐ Texte
Annotations recommandรฉes :
โข Flรจche rouge โ bouton ร cliquer
โข Encadrรฉ rouge โ champ ร remplir
โข Numรฉro โ ordre des actions
โข Texte explicatif โ clarification si besoin
PARTIE II โ Structure d'un Guide Utilisateurโ๏ธ
II.A. Modรจle Typeโ๏ธ
๐ Texte
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
GUIDE UTILISATEUR [NOM DU SERVICE]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
TABLE DES MATIรRES
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
1. Introduction
2. Accรฉder au service
3. Tรขches courantes
3.1. [Tรขche 1]
3.2. [Tรขche 2]
3.3. [Tรขche 3]
4. Foire Aux Questions (FAQ)
5. Contact et support
1. INTRODUCTION
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
[Nom du service] est l'outil de [description simple] utilisรฉ
par tous les employรฉs de [entreprise].
Avec cet outil, vous pouvez :
โข [Fonction 1]
โข [Fonction 2]
โข [Fonction 3]
Ce guide vous explique comment utiliser les fonctions essentielles.
2. ACCรDER AU SERVICE
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Adresse web : http://[url]
Identifiant : Votre identifiant habituel
Mot de passe : Votre mot de passe habituel
[Capture d'รฉcran de la page de connexion]
3. TรCHES COURANTES
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
3.1. [TรCHE 1] โ Comment faire [action] ?
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
1. [รtape 1]
[Capture annotรฉe]
2. [รtape 2]
[Capture annotรฉe]
3. [รtape 3]
[Capture annotรฉe]
Rรฉsultat attendu : [ce qui doit se passer]
4. FOIRE AUX QUESTIONS
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Q : [Question frรฉquente 1] ?
R : [Rรฉponse courte et claire]
Q : [Question frรฉquente 2] ?
R : [Rรฉponse courte et claire]
5. CONTACT ET SUPPORT
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
En cas de problรจme, contactez le support IT :
โข Email : support@entreprise.fr
โข Tรฉlรฉphone : 01 XX XX XX XX
โข Ticket GLPI : http://glpi.entreprise.fr
Horaires : Lun-Ven 8h-18h
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
II.B. Les Sections Essentiellesโ๏ธ
| Section | Contenu | Obligatoire |
|---|---|---|
| Introduction | ร quoi sert le service ? Qui l'utilise ? | โ Oui |
| Accรจs | Comment se connecter ? URL, identifiants | โ Oui |
| Tรขches courantes | 3-5 tutoriels pas-ร -pas | โ Oui |
| FAQ | Questions frรฉquentes et rรฉponses | โ Oui |
| Contact support | Qui contacter en cas de problรจme ? | โ Oui |
| Glossaire | Dรฉfinitions des termes techniques (optionnel) | โ Non |
| Raccourcis clavier | (si applicable) | โ Non |
PARTIE III โ Crรฉer des Tutoriels Efficacesโ๏ธ
III.A. Le Principe du "Pas-ร -Pas Visuel"โ๏ธ
Un tutoriel efficace suit cette structure :
๐ Texte
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
TUTORIEL : [TITRE DE L'ACTION]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Durรฉe estimรฉe : [X minutes]
Difficultรฉ : โโโ (Facile / Moyen / Avancรฉ)
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
รTAPE 1 : [ACTION]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
[Description courte]
[CAPTURE D'รCRAN ANNOTรE]
Conseil : [Astuce ou point d'attention]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
รTAPE 2 : [ACTION]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
[Description courte]
[CAPTURE D'รCRAN ANNOTรE]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
[...suite des รฉtapes...]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
RรSULTAT
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
ร la fin de ce tutoriel, vous avez [rรฉsultat obtenu].
[CAPTURE DU RรSULTAT FINAL]
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
III.B. Bonnes Pratiques des Capturesโ๏ธ
โ QUALITร DE L'IMAGE
- Rรฉsolution : 1280ร720 minimum
- Format : PNG (pas de compression, texte net)
- Recadrage : Garder uniquement la zone utile
โก ANNOTATIONS
๐ Texte
TYPES D'ANNOTATIONS UTILES
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐ด Flรจche rouge โ Indique oรน cliquer
๐ฒ Encadrรฉ rouge โ Champ ร remplir
โ โกโข Numรฉros โ Ordre des actions
๐ฌ Bulle de texte โ Explication courte
โ ๏ธ Icรดne attention โ Point important
โข COHรRENCE VISUELLE
- Utiliser toujours les mรชmes couleurs (ex : rouge pour les actions)
- Mรชme style d'annotation dans tout le guide
- Mรชme police et taille pour les textes
โฃ NOMMAGE DES FICHIERS
๐ Texte
Convention recommandรฉe :
Guide_GLPI_Etape1_Connexion.png
Guide_GLPI_Etape2_CreerTicket.png
Guide_GLPI_Etape3_RemplirFormulaire.png
PARTIE IV โ La FAQ (Foire Aux Questions)โ๏ธ
IV.A. Identifier les Questions Frรฉquentesโ๏ธ
Les questions frรฉquentes proviennent de : - Retours utilisateurs (tickets de support rรฉpรฉtitifs) - Tests utilisateurs (observation de nouveaux utilisateurs) - Anticipation (points qui semblent confus dans l'interface)
Exemples de questions frรฉquentes GLPI :
๐ Texte
Q : J'ai oubliรฉ mon mot de passe, que faire ?
Q : Comment savoir si mon ticket a รฉtรฉ traitรฉ ?
Q : Puis-je annuler un ticket ?
Q : ร qui s'adresse mon ticket ?
Q : Combien de temps avant d'avoir une rรฉponse ?
Q : Puis-je ajouter une piรจce jointe ร un ticket ?
Q : Comment voir mes tickets prรฉcรฉdents ?
Q : Que signifie "Statut : En attente" ?
IV.B. Structure d'une FAQโ๏ธ
๐ Texte
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
FOIRE AUX QUESTIONS (FAQ)
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
CONNEXION
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Q : J'ai oubliรฉ mon mot de passe, que faire ?
R : Contactez le support IT par tรฉlรฉphone (01 XX XX XX XX).
Votre mot de passe sera rรฉinitialisรฉ sous 2 heures.
Q : Mon compte est bloquรฉ, pourquoi ?
R : Aprรจs 5 tentatives de connexion รฉchouรฉes, votre compte est
automatiquement verrouillรฉ. Contactez le support.
TICKETS
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Q : Comment savoir si mon ticket a รฉtรฉ traitรฉ ?
R : Vous recevez un email automatique ร chaque changement de
statut. Vous pouvez aussi consulter "Mes tickets" sur GLPI.
Q : Combien de temps avant d'avoir une rรฉponse ?
R : Dรฉlai garanti selon la prioritรฉ :
โข Urgente : 2 heures
โข Normale : 8 heures
โข Basse : 24 heures
DIVERS
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Q : Je n'ai pas reรงu l'email de confirmation, est-ce normal ?
R : Vรฉrifiez votre dossier "Courrier indรฉsirable". Si l'email
n'y est pas, contactez le support.
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
V. Vocabulaire Clรฉโ๏ธ
| Terme | Dรฉfinition |
|---|---|
| Documentation utilisateur | Guide destinรฉ aux utilisateurs finaux (non-techniciens) |
| Documentation technique | Guide destinรฉ aux techniciens et administrateurs |
| Tutoriel | Guide pas-ร -pas pour rรฉaliser une action prรฉcise |
| FAQ | Foire Aux Questions โ liste des questions frรฉquentes et rรฉponses |
| Capture d'รฉcran annotรฉe | Image avec flรจches, encadrรฉs et textes explicatifs |
| Pas-ร -pas | Mรฉthode de prรฉsentation รฉtape par รฉtape |
| WYSIWYG | What You See Is What You Get โ รฉditeur visuel sans code |
| Glossaire | Liste de dรฉfinitions de termes techniques |