Cours CYB18 - Documentation technique et utilisateur
Cours · Fiche de cours

CYB18 - Documentation technique et utilisateur

🔒 Module CYB18 – Documentation technique et utilisateur

📘 Fiche de cours ⏱️ 2h 🎯 Bloc 3 – Cybersécurité
Objectifs : maîtriser les bonnes pratiques de rédaction d'une documentation technique (administrateurs) et d'une documentation utilisateur (utilisateurs finaux), comprendre les formats et les outils, et savoir structurer une procédure de sécurité.

📖 Introduction

La documentation est un élément essentiel de tout système d'information. Elle permet de formaliser les connaissances, de garantir la traçabilité des actions et de faciliter la transmission des compétences. En cybersécurité, une documentation bien rédigée est cruciale : elle permet aux administrateurs de réagir rapidement en cas d'incident et aux utilisateurs de respecter les bonnes pratiques de sécurité.

🎯

À l'issue de ce module, vous serez capable de :

  • Distinguer la documentation technique de la documentation utilisateur.
  • Appliquer les bonnes pratiques de rédaction (clarté, concision, structuration).
  • Choisir les formats et outils adaptés (Wiki, Markdown, PDF, etc.).
  • Rédiger une procédure de sécurité claire et opérationnelle.
  • Maintenir et mettre à jour une documentation de manière efficace.

📚 Analogie : la documentation comme un manuel d'utilisation

Imaginez que vous achetez une voiture.

  • Documentation utilisateur : le livret d'utilisation fourni avec la voiture → il explique comment démarrer, utiliser le GPS, faire le plein, etc. (pour le conducteur).
  • Documentation technique : le manuel de réparation utilisé par le garagiste → il détaille le moteur, les circuits électriques, les procédures de diagnostic (pour le technicien).
  • En cybersécurité, c'est pareil : les utilisateurs ont besoin de guides simples, les administrateurs ont besoin de procédures techniques précises.

🔍 Documentation technique vs documentation utilisateur

Critère📘 Documentation technique📖 Documentation utilisateur
PublicAdministrateurs, techniciens, développeursUtilisateurs finaux, employés
ObjectifConfigurer, maintenir, dépannerUtiliser le système en autonomie
Niveau de détailTrès détaillé, techniqueSynthétique, non technique
VocabulaireJargon technique, commandesLangage courant, simplifié
ExemplesProcédure de réponse à incident, configuration de pare-feu, scriptsGuide de création de mot de passe, utilisation de l'authentification MFA
FormatWiki, GitHub, PDF techniquePDF, page web, notice imprimée
💡 À retenir : La documentation technique est rédigée par des techniciens pour des techniciens. La documentation utilisateur est rédigée par des techniciens pour des non-techniciens.

✨ Bonnes pratiques de rédaction

1. Connaître son public

  • Pour la doc technique : utilisez un vocabulaire précis, des commandes, des schémas d'architecture.
  • Pour la doc utilisateur : évitez le jargon, utilisez des termes simples, des images et des étapes claires.

2. Structurer son document

  • Introduction : présentation du document, contexte, objectifs.
  • Prérequis : ce que le lecteur doit savoir ou avoir.
  • Procédure : étapes numérotées, claires et concises.
  • Annexes : références, liens, lexique.
  • Historique des versions : suivi des modifications.

3. Rédiger clairement

  • Phrases courtes : une idée par phrase.
  • Verbes d'action : « Cliquez sur », « Connectez-vous », « Vérifiez que ».
  • Listes à puces : pour les énumérations.
  • Numérotation : pour les étapes séquentielles.
  • Images et schémas : une image vaut mille mots.

4. Utiliser un ton adapté

  • Doc technique : ton neutre, précis, factuel.
  • Doc utilisateur : ton pédagogique, encourageant, accessible.
🧠

Astuce mnémotechnique : la méthode STAR

Pour rédiger une procédure technique, utilisez la méthode STAR :

  • Situation : dans quel contexte ?
  • Tâche : que faut-il faire ?
  • Action : comment le faire (étapes) ?
  • Résultat : quel est le résultat attendu ?

✅ DO's & ❌ DON'Ts

Bonnes pratiques (DO)À éviter (DON'T)
✅ Utiliser un langage clair et précis.❌ Utiliser du jargon sans le définir.
✅ Numéroter les étapes d'une procédure.❌ Rédiger un long paragraphe sans structure.
✅ Ajouter des captures d'écran ou schémas.❌ Se contenter d'un texte abstrait.
✅ Mettre à jour régulièrement la documentation.❌ Laisser une documentation obsolète.
✅ Tester la procédure en suivant la documentation.❌ Supposer que la procédure fonctionne sans la tester.
✅ Ajouter un lexique pour les termes techniques.❌ Utiliser des acronymes sans les définir.
✅ Utiliser des titres et sous-titres pour hiérarchiser.❌ Rédiger un « mur de texte ».

🛠️ Formats et outils de documentation

Formats courants

  • Markdown : léger, versionnable (GitHub, GitLab) → idéal pour la doc technique.
  • Wiki (MediaWiki, Confluence) : collaboratif, facile à mettre à jour.
  • PDF : figé, imprimable → pour les versions stables ou la diffusion massive.
  • HTML / pages web : accessible en ligne, intégrable dans un portail.
  • Word / Google Docs : pour les documents en cours de rédaction.

Outils recommandés

OutilTypeUsage
Git + MarkdownVersionnementDoc technique (procédures, scripts, configurations)
ConfluenceWikiDoc collaborative en entreprise
MediaWikiWiki (open-source)Grandes bases de connaissances
Draw.ioSchémasCréation de diagrammes d'architecture
PandocConversionMarkdown → PDF, HTML, DOCX
MkDocsGénérateur de siteDocumentation technique en site web statique

📄 Exemple de documentation technique

📘 Documentation technique
🔧 Procédure de réponse à incident – Compromission de compte administrateur
Version : 1.2 – 12/08/2026 Auteur : Service Sécurité 1. Prérequis - Accès au SIEM (console d'administration) - Droits admin sur les contrôleurs de domaine - Téléphone de l'astreinte sécurité 2. Détection - Vérifier les logs d'authentification (Event ID 4624, 4625) - Si + de 5 échecs en 1 min → alerte 3. Confinement - Désactiver le compte administrateur concerné - Réinitialiser le mot de passe (complexité 12+ caractères) - Révoguer tous les tokens d'accès 4. Éradication - Analyser les connexions suspectes des dernières 72h - Vérifier les tâches planifiées et les services inconnus 5. Récupération - Réactiver le compte avec un nouveau mot de passe - Mettre en place une authentification MFA obligatoire - Notifier l'équipe de direction 6. Leçons apprises - Rédiger un rapport d'incident - Mettre à jour la politique de mots de passe si nécessaire

📖 Exemple de documentation utilisateur

📖 Documentation utilisateur
🔐 Guide – Créer un mot de passe sécurisé
Pourquoi un mot de passe sécurisé ? Un mot de passe faible peut être deviné ou piraté en quelques secondes. Protégez vos comptes ! Les règles à suivre : 1. Utilisez 12 caractères minimum. 2. Mélangez majuscules, minuscules, chiffres et symboles. 3. Évitez les mots du dictionnaire, les dates de naissance, les suites logiques (1234). 4. Utilisez une phrase secrète de 4 mots aléatoires (ex: "ChatLune42%Plage"). Exemple de bon mot de passe : > Lune9!ChatPlage À ne pas faire : > motdepasse123 > 01/01/2000 Astuce : Utilisez un gestionnaire de mots de passe (Bitwarden, 1Password) pour stocker vos mots de passe en toute sécurité.

📝 Exercices d'application

Exercice 1 – Identifier le type de documentation

Pour chacune des situations suivantes, dites s'il s'agit d'une documentation technique ou utilisateur :

  • a) Un guide expliquant comment configurer un pare-feu.
  • b) Une notice pour changer son mot de passe.
  • c) Une procédure pour répondre à une attaque par ransomware.
  • d) Un tutoriel pour importer des contacts dans Outlook.
  • a) Technique (configuration d'un équipement)
  • b) Utilisateur (action quotidienne pour un non-technicien)
  • c) Technique (procédure réservée aux administrateurs)
  • d) Utilisateur (utilisation d'un logiciel bureautique)

Exercice 2 – Rédaction d'une procédure technique

Rédigez une procédure technique en 5 étapes pour créer un compte utilisateur sur un serveur Linux (commandes useradd, passwd, chown).

1. Créer l'utilisateur
sudo useradd -m -s /bin/bash alice

2. Définir un mot de passe
sudo passwd alice

3. Ajouter l'utilisateur au groupe sudo
sudo usermod -aG sudo alice

4. Vérifier la création
id alice

5. (Optionnel) Configurer l'environnement
sudo chown -R alice:alice /home/alice

Exercice 3 – Rédaction d'une documentation utilisateur

Rédigez une courte notice (5 lignes) expliquant aux utilisateurs comment activer l'authentification à deux facteurs (MFA) sur leur compte professionnel.

Activer la double authentification (MFA) sur votre compte

1. Connectez-vous à votre compte sur [portail].
2. Cliquez sur "Paramètres" puis "Sécurité".
3. Choisissez "Activer la double authentification".
4. Scannez le QR code avec une application d'authentification (Google Authenticator, Microsoft Authenticator).
5. Saisissez le code à 6 chiffres affiché sur l'application.

✅ Votre compte est maintenant protégé par MFA !

🎯 Quiz d'auto‑évaluation

1. La documentation technique s'adresse aux utilisateurs finaux.

2. Une bonne pratique de rédaction est d'utiliser des phrases courtes et des verbes d'action.

3. Le format Markdown est particulièrement adapté à la documentation technique versionnée.

4. La méthode STAR permet de structurer une procédure technique.

5. Une documentation utilisateur doit contenir du jargon technique pour être crédible.

6. Il est conseillé de tester une procédure en suivant la documentation rédigée.

📚 Ressources

Suis ta progressionConnecte-toi pour marquer les ressources comme terminées et retrouver ton avancement.
Se connecter