mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
4b465465dd
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
95 lines
6.3 KiB
Plaintext
95 lines
6.3 KiB
Plaintext
---
|
||
title: "Guides"
|
||
description: "Parcourez des guides sur les meilleures pratiques de documentation, la stratégie de contenu, l'optimisation SEO, l'accessibilité et les workflows docs-as-code pour votre équipe."
|
||
boost: 3
|
||
---
|
||
|
||
Les guides de cette section contiennent des conseils pour créer une documentation qui permet à vos utilisateurs de réussir. Que vous partiez de zéro ou que vous amélioriez une documentation existante, ces guides vous aident à planifier, rédiger et maintenir votre documentation.
|
||
|
||
Par-dessus tout, prenez en compte les besoins et les objectifs de vos utilisateurs. Documentez ce qui les aide à utiliser votre produit et à reprendre rapidement leurs tâches.
|
||
|
||
<div id="topics">
|
||
## Rubriques
|
||
</div>
|
||
|
||
<div id="ai-tools">
|
||
### Outils d'IA
|
||
</div>
|
||
|
||
Utilisez des outils d'IA pour accélérer votre flux de travail de documentation.
|
||
|
||
* [Automate documentation updates](/fr/guides/automate-agent) : tutoriel qui explique comment configurer des mises à jour automatisées de la documentation à l'aide de l'agent.
|
||
* [Build an in-app assistant](/fr/guides/assistant-embed) : tutoriel qui explique comment ajouter un chatbot IA dans une application React pour aider les utilisateurs à trouver des réponses dans votre documentation.
|
||
* [Configurer l'automerge](/fr/guides/configure-automerge) : ajoutez l'application GitHub Mintlify à la liste de contournement d'un ensemble de règles pour activer la fusion automatique des workflows.
|
||
* [Claude Code](/fr/guides/claude-code), [Cursor](/fr/guides/cursor), [Windsurf](/fr/guides/windsurf) : guides pour utiliser des assistants de programmation IA afin de maintenir la documentation.
|
||
* [GEO](/fr/guides/geo) : bonnes pratiques pour optimiser votre documentation pour les moteurs de recherche et de réponse basés sur l'IA.
|
||
|
||
<div id="api-documentation">
|
||
### Documentation d'API
|
||
</div>
|
||
|
||
Créez une documentation d'API qui permet aux utilisateurs de tester et d'apprendre à utiliser votre API, tout en étant facile à maintenir.
|
||
|
||
* [Migrer de MDX vers OAS](/fr/guides/migrating-from-mdx): Migrez votre documentation d'API depuis des pages MDX individuelles vers des pages générées automatiquement à partir d'une spécification OpenAPI.
|
||
|
||
<div id="best-practices">
|
||
### Bonnes pratiques
|
||
</div>
|
||
|
||
Faites de votre documentation une référence.
|
||
|
||
* [Accessibilité](/fr/guides/accessibility): Rendez votre documentation accessible au plus grand nombre possible.
|
||
* [Types de contenu](/fr/guides/content-types): Choisissez le bon format pour les tutoriels, guides pratiques, références et explications.
|
||
* [Modèles de contenu](/fr/guides/content-templates): Dupliquez et adaptez des modèles pour chaque type de contenu.
|
||
* [Mises en page personnalisées](/fr/guides/custom-layouts): Utilisez les modes de page et les composants pour créer des pages de destination et d'autres mises en page personnalisées.
|
||
* [Améliorer votre documentation](/fr/guides/improving-docs): Utilisez les données et les retours pour améliorer continuellement votre documentation.
|
||
* [Internationalisation](/fr/guides/internationalization): Configurez une documentation multilingue pour atteindre une audience mondiale.
|
||
* [Liens](/fr/guides/linking) : Créez des liens internes, référencez des points de terminaison d'API et garantissez l’intégrité des liens dans toute votre documentation.
|
||
* [Maintenance](/fr/guides/maintenance): Gardez votre documentation précise et à jour.
|
||
* [Médias](/fr/guides/media): Ajoutez des images, des vidéos et d’autres médias de manière efficace tout en maîtrisant la charge de maintenance.
|
||
* [Organiser la navigation](/fr/guides/navigation): Concevez une architecture de l’information adaptée à vos utilisateurs.
|
||
* [SEO](/fr/guides/seo): Optimisez votre documentation pour les moteurs de recherche.
|
||
* [Style et ton](/fr/guides/style-and-tone): Écrivez avec un ton cohérent.
|
||
* [Comprendre votre audience](/fr/guides/understand-your-audience): Étudiez les besoins et objectifs de vos utilisateurs et répondez-y.
|
||
|
||
<div id="git-workflows">
|
||
### Flux de travail Git
|
||
</div>
|
||
|
||
Comprenez Git pour tirer le meilleur parti de Mintlify et d'une approche « docs-as-code » de la documentation.
|
||
|
||
* [Concepts de Git](/fr/guides/git-concepts) : Apprenez les fondamentaux de Git pour la documentation.
|
||
* [Branches](/fr/guides/branches) : Utilisez des branches pour gérer les modifications de la documentation.
|
||
|
||
<div id="use-cases">
|
||
### Cas d’utilisation
|
||
</div>
|
||
|
||
Découvrez comment Mintlify répond à différents cas d’utilisation et trouvez une solution adaptée à vos besoins.
|
||
|
||
* [Créer une documentation développeur](/fr/guides/developer-documentation) : Aidez vos utilisateurs à tirer le meilleur parti de votre produit ou de votre API grâce à une documentation développeur qui répond à leurs questions et leur permet de revenir rapidement à leurs tâches principales.
|
||
* [Créer une base de connaissances](/fr/guides/knowledge-base) : configurez une base de connaissances interne pour centraliser les informations de votre équipe, améliorer la recherche et réduire la charge de maintenance.
|
||
* [Créer un centre d’aide](/fr/guides/help-center) : Créez un centre d’aide en libre-service qui permet aux utilisateurs de trouver des réponses par eux-mêmes, réduit le volume de tickets et améliore la satisfaction client.
|
||
* [Créer un frontend personnalisé](/fr/guides/custom-frontend) : utilisez l’intégration Mintlify Astro pour afficher votre documentation avec un frontend entièrement personnalisé.
|
||
|
||
<div id="where-to-start">
|
||
## Par où commencer
|
||
</div>
|
||
|
||
<CardGroup cols={2}>
|
||
<Card title="Vous débutez avec la documentation ?" icon="rocket" href="/fr/guides/content-types">
|
||
Découvrez les types de contenu pour comprendre comment structurer votre documentation.
|
||
</Card>
|
||
|
||
<Card title="Vous améliorez une documentation existante ?" icon="chart-line" href="/fr/guides/improving-docs">
|
||
Découvrez comment utiliser les indicateurs et les retours pour améliorer votre documentation.
|
||
</Card>
|
||
|
||
<Card title="Vous configurez des fonctionnalités d’IA ?" icon="bot" href="/fr/guides/automate-agent">
|
||
Automatisez les mises à jour de la documentation avec l’agent.
|
||
</Card>
|
||
|
||
<Card title="Vous travaillez en équipe ?" icon="git-merge" href="/fr/guides/git-concepts">
|
||
Apprenez les workflows Git pour une documentation collaborative.
|
||
</Card>
|
||
</CardGroup> |