Aller au contenu

Documentation d'API

Pages de la documentation sur le thème Documentation d'API (3 pages).

  • À propos de l'API de ce manuel

    Ce manuel expose l'intégralité de son corpus sous forme d'API statique, sans exécution serveur, pour les LLM et agents IA — llms.txt, miroirs Markdown par page et index JSON. À quoi ça sert et comment l'utiliser.

  • Modèle : documentation d'API

    Un modèle Markdown prêt à copier pour documenter un endpoint d'API REST - aperçu, méthode, paramètres, exemples de requête/réponse et codes d'erreur.

  • Typologie de l'information

    Comprendre la typologie de l'information en rédaction technique : comment Concept, Tâche et Référence structurent le contenu selon l'intention du lecteur, et comment ce principe s'articule avec DITA, Markdown et OpenAPI.

Tous les thèmes