Modèles de contenu de documentation

Copiez et adaptez des modèles MDX prêts à l’emploi pour les guides pratiques, tutoriels, explications et pages de référence d’API.

Utilisez ces modèles comme point de départ pour créer votre documentation. Personnalisez-les en fonction de votre documentation et de votre public.

1. Copiez le modèle qui correspond à votre type de contenu.
2. Remplacez les espaces réservés et le contenu d’exemple par votre propre contenu.
3. Ajustez les sections si nécessaire.
4. Supprimez les sections qui ne s’appliquent pas.

Vous ne savez pas quel modèle choisir ? Consultez la page sur les types de contenu pour savoir quand utiliser chacun d’entre eux.

​

Modèle de guide pratique

Utilisez des guides pratiques lorsque les utilisateurs doivent accomplir une tâche précise et qu’ils connaissent déjà un minimum votre produit. Les guides pratiques sont orientés vers un objectif et vont droit à la solution.

How-to guide template

---
title: "[Les titres doivent commencer par un verbe]"
description: "[Effectuer une tâche spécifique] pour [atteindre un résultat]."
---

Commencez par une brève description de ce que ce guide permet aux utilisateurs d'accomplir.

## Prérequis (facultatif)

Listez uniquement ce qui est nécessaire :

- Configuration ou paramétrage requis
- Permissions nécessaires
- Fonctionnalités associées à configurer au préalable

## [Titre orienté action décrivant la tâche]

Fournissez des instructions directes pour atteindre l'objectif.

1. Ouvrez [emplacement] et accédez à [lieu spécifique]
2. Cliquez sur [bouton ou option]
3. Saisissez [informations requises]
4. Cliquez sur [bouton de confirmation]

```language
// Incluez des exemples de code que les utilisateurs peuvent copier et modifier
```

<Tip>
  Incluez des conseils pratiques pour aider les utilisateurs à éviter les erreurs courantes ou à travailler plus efficacement.
</Tip>

## Vérifier le résultat (facultatif)

Si la réussite n'est pas évidente, expliquez comment les utilisateurs peuvent confirmer qu'ils ont terminé la tâche avec succès.

## Dépannage (facultatif)

Traitez les problèmes courants que les utilisateurs pourraient rencontrer :

- **Description du problème** : Solution ou contournement
- **Un autre problème courant** : Comment le résoudre

## Tâches associées

Ajoutez des liens vers des guides pratiques associés ou les prochaines étapes.

​

Modèle de tutoriel

Utilisez les tutoriels lorsque vous souhaitez aider les nouveaux utilisateurs à apprendre en pratiquant. Les tutoriels guident les utilisateurs étape par étape à travers une expérience d’apprentissage complète, avec un résultat clair.

Tutorial template

---
title: "[Action verb] [specific outcome]"
description: "Learn how to [specific outcome] by [method or approach]."
---

Use an introduction paragraph to explain what users can expect to learn and what they can do after completing this tutorial.

## Prerequisites

List what users need before starting:

- Required knowledge or skills
- Tools, accounts, or permissions
- Time commitment (optional)

## Step 1: [First action]

Provide clear, specific instructions for the first step.

```language
// Inclure des exemples de code si utile
```

Explain what this step accomplishes and why it matters.

## Step 2: [Second action]

Continue with sequential steps that build on previous work.

Point out milestones and progress markers so users know they're on track.

## Step 3: [Third action]

Keep steps focused on concrete actions rather than theory.

Minimize choices that users need to make.

## Next steps

Summarize what users learned and suggest logical next steps:

- Related tutorials to try
- How-to guides for common tasks
- Additional resources for deeper learning

​

Modèle d’explication

Utilisez des explications lorsque les utilisateurs ont besoin de comprendre des concepts, des décisions de conception ou le fonctionnement de fonctionnalités complexes. Les explications fournissent du context et approfondissent la compréhension plutôt que de donner des instructions étape par étape.

Explanation template

---
title: "About [concept or feature]"
description: "Understand [concept] and how it works within [product or context]."
---

Start with a clear statement of what this explanation covers and why understanding it matters.

Define the concept in plain language. Explain what it is, what it does, and why it exists.

Use analogies or comparisons to familiar concepts when helpful.

## How [concept] works

Explain the underlying mechanics, architecture, or process.

<Frame>
  <img src="/path/to/diagram.png" alt="Diagram showing how [concept] works" />
</Frame>

Break down complex ideas into digestible sections.

## Why [design decision or approach]

Provide context about why things work the way they do.

Discuss trade-offs, alternatives that were considered, or constraints that influenced the design.

## Quand utiliser [concept]

Aidez les utilisateurs à comprendre quand ce concept ou cette approche est le plus approprié.

- **Cas d'usage 1** : Quand cette approche est pertinente
- **Cas d'usage 2** : Un autre scénario où c'est le bon choix
- **Non recommandé pour** : Situations où les alternatives sont préférables

## Relationship to other features

Draw connections to related concepts or features in your product.

Explain how this concept fits into the broader system or workflow.

## Common misconceptions

Address misunderstandings or clarify subtle distinctions.

## Further reading

Link to related explanations, tutorials, or reference documentation.

​

Modèle de référence

Utilisez la documentation de référence lorsque les utilisateurs doivent rechercher des informations précises sur les fonctionnalités de votre produit. Les documents de référence privilégient la précision, la cohérence et la facilité de consultation rapide.

Reference template

---
title: "Référence [nom de la fonctionnalité ou de l'API]"
description: "Référence complète des propriétés, paramètres et options de [la fonctionnalité ou de l'API]."
---

Provide a one-sentence description of what this feature or API does.

## Properties

<ParamField body="property1" type="string" required>
  Brief description of the property.
</ParamField>

<ParamField body="property2" type="number">
  Brief description with default value if applicable.
</ParamField>

<ParamField body="property3" type="boolean" default="false">
  Brief description.
</ParamField>

## Parameters

<ParamField body="parameterName" type="string">
  Description of what this parameter does and when to use it.

```language
// Example showing typical usage
```
</ParamField>

<ParamField body="anotherParameter" type="object">
  Description of the parameter.

  Available options:

  - `option1`: Description of this option.
  - `option2`: Description of this option.
</ParamField>

## Examples

### Basic example

```language title="Basic usage"
// Minimal example showing common use case
```

### Advanced example

```language title="Advanced configuration"
// Example with multiple options configured
```

## Response

If documenting an API, describe the response structure.

<ResponseField name="field1" type="string" required>
  Description of the response field.
</ResponseField>

<ResponseField name="field2" type="number">
  Description of another response field.
</ResponseField>

Example response:

```json
{
  "field1": "value",
  "field2": 123
}
```

## Related references

Link to related reference documentation.

​

Pages associées

Types de contenu

Choisissez le bon type de contenu pour atteindre vos objectifs de documentation.

Style et ton

Rédigez une documentation efficace avec un style cohérent.

Mettre le texte en forme

Apprenez à mettre le texte en forme et à travailler la présentation du contenu.