Préparation de la documentation et du déploiement

Se connecter pour s'inscrire

CI/CD et automatisation

Documenter l’architecture, l’installation et l’exploitation pour rendre une application déployable et récupérable.

  1. Public cible

    Débutants, étudiants et professionnels qui souhaitent acquérir une pratique structurée dans ce domaine.

  2. Objectifs

    Comprendre les notions essentielles et les appliquer dans un projet vérifiable.

  3. Prérequis

    Aucune connaissance préalable n’est strictement obligatoire ; les prérequis détaillés sont précisés dans les ateliers.

  4. Niveau

    Bac+3

  5. Ressources

    • Documentation officielle et références citées dans les ateliers.
    • Exercices, examens et projet de synthèse du catalogue.
  6. Validation des compétences

    La validation repose sur les évaluations actives et les livrables pratiques du cours.

  7. Besoins techniques

    Un ordinateur, un navigateur et les outils indiqués dans le premier atelier sont suffisants pour commencer.

Exercices, examens et projets

Documentation et déploiement

Exercice

Atelier de mise en pratique

Réaliser une activité pratique et documenter ses choix.

Obligatoire Consulter
Examen

Examen de fin de module

Évaluer les notions et leur mise en pratique.

Obligatoire Consulter
Projet

Projet de synthèse

Livrer un résultat complet, testé et documenté.

Livrables :

  • Production attendue
  • Documentation
  • Présentation
Obligatoire Consulter

Préparation de la documentation et du déploiement

Rendre une application compréhensible et déployable par une équipe qui ne l’a pas développée, grâce à une documentation utile et vérifiable.

À la fin du cours

  • Documenter architecture, installation, configuration et exploitation.
  • Écrire des runbooks actionnables pour le support et les incidents.
  • Gérer versions, migrations, compatibilités et informations de sécurité.
  • Adapter la documentation aux utilisateurs et aux équipes techniques.

Organisation

Le cours suit l’architecture, l’installation, l’exploitation et le cycle de versions.

Prérequis : Notions de lecture de configuration et de déploiement.

Documenter l’architecture

Décrire le rôle de chaque composant, ses dépendances, les flux principaux et les frontières de sécurité. Ajouter un schéma de déploiement et une table des versions supportées.

Documenter les décisions et leurs alternatives afin qu’un changement puisse être compris sans retrouver l’histoire de l’équipe.

Client → reverse proxy → application → base ; bus → consommateurs asynchrones
Point de contrôle : Un nouveau développeur peut identifier les composants critiques sans explorer tout le code.

Installation et configuration

Écrire une procédure qui part d’un environnement connu et indique les prérequis, les commandes, les variables attendues et les vérifications. Distinguer les étapes obligatoires des options.

Ne jamais placer un secret dans la documentation. Fournir un fichier d’exemple et indiquer où obtenir chaque valeur.

1. Installer les prérequis; 2. copier .env.example; 3. installer; 4. lancer le smoke test.
Point de contrôle : La procédure peut être exécutée par une personne extérieure avec un README vierge.

Exploitation et runbooks

Un runbook part du symptôme, donne les commandes de diagnostic, explique les risques et décrit la Escalade. Éviter les étapes dépendant d’un nom de machine ou d’un secret non documenté.

Prévoir les sauvegardes, la rotation des certificats, la gestion des logs et la procédure de retour arrière. Tester les procédures avec un exercice régulier.

Méthode

  1. Décrire le symptôme observable.
  2. Collecter les preuves.
  3. Appliquer la correction validée.
  4. Vérifier et escalader.
Point de contrôle : Une personne non spécialiste peut suivre le runbook sans improviser une commande destructive.

Versions et communication

Associer la documentation à une version de l’application. Les changements incompatibles, migrations, nouvelles variables et dates de support doivent être visibles dans un journal de versions.

Adapter le niveau de détail : une guide utilisateur décrit les tâches, un guide technique décrit les opérations et un runbook décrit l’urgence.

Version 2.1 : migration 0007 obligatoire avant activation du worker 2
Point de contrôle : Une version peut être installée et comprise à partir des documents publiés.

Livrables et validation

Le livrable doit montrer une compréhension personnelle, des choix explicités et une vérification par un cas de test ou une procédure reproductible.

  • Une architecture à jour et un glossaire métier.
  • Un guide d’installation et de configuration.
  • Des runbooks d’exploitation, sauvegarde et incident.
  • Un journal de versions avec procédure de retour.
Critère de réussite : La documentation est validée lorsqu’une personne extérieure installe, configure et exécute un runbook sans information cachée.

Compétences du référentiel France Compétences

Ces blocs sont publiés par France Compétences. Academy n’est pas certificateur de ces titres : suivre ce cours ne vaut pas validation d’un bloc de compétences RNCP.

Support et mise à disposition de services informatiques
Gérer le patrimoine informatique · Répondre aux incidents et aux demandes d’assistance et d’évolution · Développer la présence en ligne de l’organisation · Travailler en mode projet · Mettre à disposition des utilisateurs un service informatique · Organiser son développement professionnel ·
Tester et mettre en production les ressources et assurer leur amélioration continue
Formaliser un plan de tests · Réaliser les mises en production des solutions informatiques · Assurer les mises à jour mineures et majeures · Assurer le support aux utilisateurs et aux équipes techniques · Mettre à jour les référentiels de production ·
Piloter un projet de développement d’application web ou mobile
Élaborer un planning dans un contexte Agile · Mettre en place la méthode Agile · Définir des KPI adaptés au contexte du projet · Créer une approche de tests liée au développement · Mettre en place des stratégies de versioning et de collaboration ·
Préparer le déploiement d’une application sécurisée
Préparer et exécuter les plans de tests d’une application · Préparer et documenter le déploiement d’une application · Contribuer à la mise en production dans une démarche DevOps ·
Déployer une application web ou mobile
Déployer une application web ou mobile · Déployer une API de manière sécurisée · Automatiser le déploiement d’une application · Surveiller les performances en production · Définir des axes d’amélioration ·
Mettre en production une application web & mobile
Utiliser, configurer et monitorer un service d’hébergement · Mettre en place les outils de mise en production · Concevoir et mettre en place un environnement de tests · Assurer la compatibilité avec les principaux moteurs de recherche ·
Utilisation de la méthodologie DevOps pour automatiser, conteneuriser et déployer une application en continu
Identifier les points d’automatisation possibles · Programmer les actions avec un langage de script · Créer un environnement de développement conteneurisé · Assurer un déploiement continu avec une plateforme d’intégration continue ·

Fiches officielles rattachées au parcours :

Publié le 29/11/2025