Numérique & IA

Documentation technique : Markdown, API et Swagger

Proposée par Sujet Verbe Complement

Durée
8 jours
Lieu
Amiens
Format
Hybride
Niveau
Tout public

Ce que vous allez apprendre

Apprenez à rédiger une documentation claire, à la documenter pour une API et à la publier sur un wiki collaboratif qui suit l'évolution du code.

À l'issue de la formation, vous serez capable de

  • Définir le rôle et le public de chaque documentation avant de l'écrire
  • Rédiger un texte technique clair, concis et bien structuré
  • Structurer des documents en Markdown et les versionner avec le code
Lire la suite
  • Décrire une API REST avec la spécification OpenAPI
  • Générer une documentation interactive avec Swagger Editor et Swagger UI
  • Créer et organiser un wiki sur GitHub ou GitLab, relié à l'intégration continue
  • Produire des documents Word, Excel et PowerPoint adaptés à un public non technique

Programme

Jour 1: écrire une documentation qu'on relit

  • Rôle et enjeux de la documentation
  • Typologie: documentation utilisateur, technique et d'API
  • Choisir son public et les circonstances de lecture avant d'écrire
  • Rédaction technique: clarté, concision, structure
  • Adapter son écriture à son public, conventions et normes usuelles
  • Syntaxe complète du Markdown et bonnes pratiques de structuration
  • Outils et éditeurs Markdown, versionnement avec le code

Jour 2: documenter une API et publier

  • Rappels REST: points d'entrée et méthodes HTTP
  • Principes d'une documentation d'API utilisable
  • Spécification OpenAPI, Swagger Editor et Swagger UI
  • Génération d'une documentation interactive
  • Créer et organiser un wiki sur GitHub et sur GitLab
  • Fonctionnalités avancées des wikis
  • Articulation avec l'intégration continue pour que la documentation suive le code
  • Outils bureautiques Word, Excel et PowerPoint: modèles, styles, automatisation

Pour qui ?

Prérequis

Public: Développeurs, chefs de projet, rédacteurs techniques.

Prérequis: Aucun pour les premiers jours; connaissances web de base pour la partie API.

Questions fréquentes

Combien de temps dure la formation ?

La formation dure 8 jours, et le volume indiqué est de 2 jours, modulable selon les besoins.

À qui s'adresse cette formation ?

Elle s'adresse aux développeurs, aux chefs de projet et aux rédacteurs techniques.

Faut-il des prérequis ?

Aucun prérequis n'est demandé pour les premiers jours ; des connaissances web de base sont utiles pour la partie API.

Où se déroule la formation ?

Elle alterne présentiel et distance, avec une partie à Amiens.

Peut-on la financer ?

Elle n’est pas indiquée comme éligible au CPF, mais France Travail ou votre employeur peuvent la financer selon votre situation.

Comment payer cette formation ?

  • Votre CPFCette formation n’est pas indiquée comme éligible au CPF. Le centre vous dira si une autre version l’est.
  • Si vous cherchez un emploiFrance Travail peut financer tout ou partie de la formation avec l’aide individuelle à la formation (AIF), si elle vous aide à retrouver un poste.
  • Si vous êtes salarié(e)Votre employeur peut la prendre en charge dans son plan de formation, souvent avec l’aide de son OPCO.
Estimer mon reste à charge Lire le guide : France Travail et AIF

Sujet Verbe Complement

Cet organisme propose des formations IT en développement web, administration Linux, bases de données, API REST et DevOps. Il forme aussi bien en école qu'en entreprise, à Amiens, Paris, Lille et à distance.

Découvrir le centre

Quelle formation cherchez‑vous ?