Documentation technique

Présentation

Formation de 8 jours couvrant l’ensemble des compétences de documentation technique : de la rédaction claire à la publication de documentation API avec Swagger/OpenAPI.

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

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

Programme

Jour 1 — Écrire une documentation qu’on relit

Ce que la documentation doit produire. Rôle et enjeux, typologie — documentation utilisateur, technique, d’API — et la question qu’on tranche avant d’écrire : pour qui, et lue dans quelles circonstances.

Rédaction technique. Clarté, concision, structure. Adapter l’écriture à son public, conventions et normes usuelles.

Markdown. Syntaxe complète, bonnes pratiques de structuration, outils et éditeurs. Le format qui permet de versionner la documentation avec le code plutôt qu’à côté.

Jour 2 — Documenter une API et publier

Documentation d’API. Rappels REST, points d’entrée et méthodes HTTP, puis les principes d’une documentation d’API utilisable. Spécification OpenAPI, Swagger Editor et Swagger UI, génération d’une documentation interactive.

Wikis collaboratifs. Créer et organiser un wiki sur GitHub et sur GitLab, fonctionnalités avancées, articulation avec l’intégration continue pour que la documentation suive le code.

Outils bureautiques. Word, Excel et PowerPoint dans un contexte technique : modèles, styles, automatisation — ce qui reste incontournable quand le destinataire ne lira jamais un dépôt Git.

Modalités

• Volume : 2 jours (modulable)
• Format : présentiel ou distanciel

Demander un devis

ou écrire directement, objet déjà rempli.