Aller au contenu

Markdown

Pages de la documentation sur le thème Markdown (8 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.

  • Exemple : une page Markdown bien structurée

    Un exemple abouti d'article concept en Markdown, annoté pour expliquer pourquoi chaque choix structurel a été fait.

  • Format source

    Les traitements de texte nous ont déshabitués à distinguer le fond de la forme. Mais confondre les deux entraîne beaucoup d'erreurs et de perte de temps.

  • Modèle : article concept

    Un modèle de rédaction prêt à l'emploi pour concevoir un article concept — un type d'information répondant à « Qu'est-ce que c'est ? » avec définitions, contexte, principes et exemples.

  • Modèle : article référence

    Un modèle Markdown prêt à copier pour rédiger un article référence, selon la structure Aperçu / Syntaxe / Paramètres / Exemples / Limitations.

  • Modèle : article tâche

    Un modèle Markdown prêt à copier pour rédiger un article tâche/didacticiel, selon la structure Objectif / Prérequis / Étapes / Résultat attendu / Dépannage.

  • 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