Modèle : article référence

Type d'information :Référence•"Quels sont les détails ?"

Données de référence, syntaxe exacte, paramètres et contraintes

Modèle

Ceci est un point de départ à copier et adapter, pas un exemple abouti. Pour une version remplie, voir le modèle de documentation d’API, un cas particulier de ce patron. Pour comprendre comment le contenu de référence s’intègre dans l’architecture documentaire, lisez Typologie de l’information.

Utilisez cette structure quand l’intention première du lecteur est la consultation - il sait déjà ce qu’il cherche à accomplir et a besoin de la syntaxe exacte, des paramètres, des commandes ou des spécifications. Contrairement à un article concept ou tâche, personne ne lit un article référence de bout en bout ; on le parcourt pour trouver un seul détail.

Gardez le type d’informationTypage de l'informationLa discipline consistant à classer le contenu selon son objectif communicatif (concept, tâche, référence) plutôt que de rédiger une prose indifférenciée.Voir dans le glossaire → principal clair : un article référence intègre couramment des exemples de syntaxe concrets pour illustrer des options, mais les tutoriels pas-à-pas relèvent d’un article tâche et les explications d’architecture d’un article concept.

La structure ci-dessous est un modèle de rédaction pratique conçu pour un flux MarkdownMarkdownLangage de balisage léger en texte brut, où la mise en forme s'exprime par une ponctuation simple, par exemple un # en début de ligne pour un titre. Facile à rédiger et à relire sous gestion de versions, il n'impose aucun schéma : les équipes docs-as-code compensent par des modèles et des contrôles automatisés. Ce manuel est rédigé en MDX, une variante de Markdown.Voir dans le glossaire → / Astro léger, appliquant le principe de typologie de l’information sans schémas DITA XMLDITA XMLUne architecture de rédaction structurée et modulaire, construite autour de la typologie concept/tâche/référence et de la réutilisation de contenu via conrefs et ditamaps.Voir dans le glossaire → ni contraintes DTDDTD (Document Type Definition)Le plus ancien langage de schéma XML : il déclare les éléments et les attributs qu'un document peut contenir, et dans quel ordre. DITA XML est distribué avec des DTD aussi bien qu'avec des schémas XSD.Voir dans le glossaire → :

---
title: "<Nom de la commande, option ou élément>"
description: "<Une phrase : de quoi ceci est la référence>"
contentType: reference
---

## Aperçu

<Une ou deux phrases de contexte — de quoi permettre à quelqu'un qui
arrive ici depuis une recherche de savoir qu'il est au bon endroit.>

## Syntaxe

<La syntaxe exacte et littérale. Un bloc de code, pas de la prose.>

## Paramètres

| Paramètre | Type | Obligatoire | Description |
| --- | --- | --- | --- |
| `<nom>` | `<type>` | Oui/Non | <ce qu'il fait> |

## Exemples

<Au moins un exemple complet et exécutable — pas un fragment.>

## Limitations

<Contraintes connues, combinaisons non prises en charge ou cas
limites. Omettez si aucune n'existe ; n'inventez pas de mises en
garde pour remplir la section.>

## Références connexes

- [<Référence connexe 1>](<lien>)
- [<Référence connexe 2>](<lien>)

Quand omettre une section

• Limitations : uniquement si de vraies limitations existent.
• Paramètres : si l’élément documenté ne prend aucun paramètre, remplacez le tableau par une note d’une ligne le précisant - ne supprimez pas le titre en silence, son absence doit être explicite, pas implicite.
• Ne jamais omettre Syntaxe ni Exemples - un article référence sans forme littérale et copiable ne remplit pas son rôle.