-
Rôles et objectifs de la documentation technique
Pourquoi documenter ? Traçabilité, transfert de compétences, conformité
Types de documentation : procédures, fiches techniques, topologies, changelog
Qui écrit ? Pour qui ? (technique, métier, auditeur…)
Outils utilisés : Word, Markdown, Wiki (DokuWiki, Confluence…), Git
Travaux pratiques
Analyser une documentation existante et identifier ses lacunes ou erreurs
-
Structurer une documentation claire et exploitable
Méthodes de structuration : plan logique, titres, sommaire, annexes
Rédaction efficace : clarté, concision, terminologie cohérente
Ajout de visuels : captures d’écran, schémas, diagrammes d’architecture
Versionnage et gestion des mises à jour
Travaux pratiques
Rédiger une procédure technique (ex. : déploiement d’une VM, configuration d’un service)
-
Documentation de l’infrastructure et cartographie technique
Cartographie physique et logique (réseaux, serveurs, flux)
Outils : Draw.io, Lucidchart, Visio, Diagrams.net
Inventaire matériel/logiciel, nomenclature des équipements
Référentiels à jour : adresses IP, utilisateurs, mots de passe (coffre-fort)
Travaux pratiques
Réaliser un schéma de topologie réseau ou système d’une petite infrastructure simulée
-
Maintenance documentaire et diffusion
Plan de mise à jour documentaire
Gestion collaborative (Git, Wiki, répertoires partagés)
Archivage, suivi de version, approbation
Diffusion et accessibilité (droits, indexation, sécurité documentaire)
Travaux pratiques
Mettre à jour une documentation obsolète selon une nouvelle version système ou procédure
Savoir rédiger une documentation technique claire et utile
Structurer les informations pour une reprise facile
Organiser le suivi d’une infrastructure de manière professionnelle
Ce que vous allez apprendre
-
Comprendre les enjeux et les standards attendus d’une documentation technique
-
Rédiger une documentation technique fiable, autonome et réutilisable
-
Créer une cartographie technique exploitable pour le support ou l’audit
-
Maintenir une documentation vivante et fiable, alignée sur l’évolution du SI
Modalités d'évaluation
Evaluation de la progression en cours de formation à l'aide de cas pratiques, mises en situation, QCM…
Test de positionnement en amont et en aval afin de valider les compétences acquises.
Accessibilité
Toutes nos formations sont accessibles aux personnes en situation de handicap.
Pour plus de renseignements, n'hésitez pas à nous contacter.
Modalités pédagogiques
- Méthodes : Expositive, démonstrative et active
- Moyens : Cas pratique, mise en situation
- Ressources : Support de cours et Programme de formation
- Moyens techniques : Teams
