mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
390c9485bf
* docs: fix verified gaps in recently changed pages * docs: mirror PR fixes into es, fr, zh and improve pages description * Update poc-onboarding.mdx --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
363 lines
18 KiB
Plaintext
363 lines
18 KiB
Plaintext
---
|
|
title: "Onboarding POC"
|
|
description: "Configurez et évaluez une preuve de concept Mintlify, de la connexion de votre dépôt à la revue des workflows de publication, d'IA et de sécurité."
|
|
keywords: ["POC", "preuve de concept", "essai", "évaluation", "onboarding entreprise", "pilote"]
|
|
noindex: true
|
|
---
|
|
|
|
Utilisez ce guide pour mettre en place un site de documentation fonctionnel et évaluer Mintlify avec votre équipe. La plupart des tâches se déroulent dans le tableau de bord, mais vous aurez besoin d'une aide ponctuelle des administrateurs GitHub et IT pour certaines étapes.
|
|
|
|
<Note>
|
|
Si vous êtes bloqué, contactez votre responsable de compte (AE, account executive) ou votre ingénieur solutions (SE, solutions engineer), ou écrivez à [support@mintlify.com](mailto:support@mintlify.com).
|
|
</Note>
|
|
|
|
<div id="poc-workflow">
|
|
## Workflow du POC
|
|
</div>
|
|
|
|
Effectuez ces étapes dans l'ordre :
|
|
|
|
| Étape | Résultat |
|
|
|---|---|
|
|
| 1. Connecter votre dépôt | Déployer un site de démarrage. |
|
|
| 2. Inviter votre équipe | Donner aux participants l'accès dont ils ont besoin. |
|
|
| 3. Ajouter du contenu d'exemple | Tester des pages représentatives et complexes. |
|
|
| 4. Publier une modification | Vérifier votre workflow de rédaction et de revue. |
|
|
| 5. Appliquer votre image de marque | Aligner le site sur votre produit. |
|
|
| 6. Tester les fonctionnalités d'IA | Évaluer les réponses de l'assistant et un workflow d'IA. |
|
|
| 7. Passer en revue les résultats | Comparer le POC à vos critères de réussite. |
|
|
|
|
Votre dépôt reste la source de vérité. Le tableau de bord vous permet de modifier, configurer et publier les fichiers `.mdx` et la configuration `docs.json` de ce dépôt. Votre site en ligne affiche le résultat publié.
|
|
|
|
<div id="before-you-begin">
|
|
## Avant de commencer
|
|
</div>
|
|
|
|
<div id="identify-participants">
|
|
### Identifier les participants
|
|
</div>
|
|
|
|
| Rôle | Responsabilité | Temps nécessaire |
|
|
|---|---|---|
|
|
| Responsable de la documentation | Pilote le POC et réalise la plupart des étapes. | Quelques heures au total |
|
|
| Administrateur GitHub | Approuve la GitHub App Mintlify. | 15 minutes |
|
|
| Designer ou responsable de la marque | Fournit les logos, les couleurs et les polices. | 30 minutes |
|
|
| Administrateur des identités ou IT | Configure le DNS pour un domaine personnalisé, si vous testez l'authentification. | 1 à 2 heures |
|
|
|
|
<div id="gather-your-content-and-brand-assets">
|
|
### Rassembler votre contenu et vos éléments de marque
|
|
</div>
|
|
|
|
Rassemblez :
|
|
|
|
- Les variantes claire et sombre de votre logo au format SVG ou PNG.
|
|
- Un favicon, de préférence au format SVG.
|
|
- Les couleurs de votre marque sous forme de valeurs hexadécimales.
|
|
- Les fichiers de polices ou les noms de vos Google Fonts.
|
|
- Un lien vers votre documentation actuelle ou un export du contenu.
|
|
- Votre fichier ou URL OpenAPI, si vous documentez une API.
|
|
- Vos 20 à 30 pages les plus consultées.
|
|
|
|
<div id="define-success">
|
|
### Définir la réussite
|
|
</div>
|
|
|
|
Choisissez l'un des leviers de valeur sur lesquels les clients évaluent le plus souvent Mintlify, puis notez sa valeur de référence actuelle :
|
|
|
|
- **Acquisition :** améliorer le taux d'activation ou le délai jusqu'à la première intégration.
|
|
- **Déviation :** réduire le volume de tickets pour un sujet de support courant.
|
|
- **Temps d'ingénierie économisé :** réduire les heures d'ingénierie consacrées à la rédaction, à la revue et à la maintenance de la documentation.
|
|
- **Rétention :** augmenter l'adoption d'une fonctionnalité après son lancement.
|
|
|
|
Ajoutez deux ou trois critères que vous pouvez tester pendant le POC. Par exemple :
|
|
|
|
- Un rédacteur sans expérience de Git peut publier une modification sans aide.
|
|
- Votre page de référence d'API la plus complexe s'affiche correctement.
|
|
- L'assistant répond à 8 questions de support courantes sur 10 et cite les bonnes pages.
|
|
- Votre fournisseur d'identité prend en charge la connexion au tableau de bord.
|
|
|
|
Partagez l'objectif, la valeur de référence et les critères avec votre AE ou SE.
|
|
|
|
<div id="step-1-connect-your-repository">
|
|
## Étape 1 : connecter votre dépôt
|
|
</div>
|
|
|
|
<Warning>
|
|
Un propriétaire de l'organisation GitHub ou un administrateur du dépôt doit approuver la GitHub App Mintlify avant que votre site puisse être déployé.
|
|
</Warning>
|
|
|
|
<Steps>
|
|
<Step title="Créer votre compte">
|
|
Accédez à [mintlify.com/start](https://mintlify.com/start) et inscrivez-vous avec votre adresse e-mail professionnelle.
|
|
</Step>
|
|
|
|
<Step title="Choisir un dépôt">
|
|
Connectez GitHub pendant l'onboarding. Créez un dépôt ou sélectionnez un dépôt vide dans l'organisation de votre entreprise. Un dépôt privé nommé `docs` est un choix courant.
|
|
|
|
Ne sélectionnez pas un dépôt qui contient du code applicatif ou des fichiers sans rapport avec la documentation.
|
|
</Step>
|
|
|
|
<Step title="Installer la GitHub App">
|
|
Demandez à votre administrateur GitHub d'installer la GitHub App Mintlify. Accordez l'accès au dépôt de documentation en sélectionnant **Only select repositories**.
|
|
|
|
Consultez [Installer la GitHub App](/fr/deploy/github#install-the-github-app) pour connaître les autorisations demandées.
|
|
|
|
<Accordion title="Demander l'approbation d'un propriétaire de l'organisation">
|
|
Si vous ne pouvez pas approuver l'application, soumettez la demande d'installation. GitHub notifie les propriétaires de votre organisation.
|
|
|
|
Pour continuer en attendant l'approbation, ignorez le fournisseur Git pendant l'onboarding. Mintlify crée un dépôt privé que vous pourrez déplacer plus tard depuis les [paramètres Git](https://app.mintlify.com/settings/deployment/git-settings). Consultez [Cloner dans votre propre dépôt](/fr/deploy/github#clone-to-your-own-repository).
|
|
</Accordion>
|
|
</Step>
|
|
|
|
<Step title="Ouvrir votre site">
|
|
Une fois le contenu de démarrage déployé, trouvez votre URL sur la page **Overview** du [tableau de bord](https://app.mintlify.com/). Ouvrez l'URL `https://<your-subdomain>.mintlify.site` et confirmez qu'elle se charge.
|
|
</Step>
|
|
</Steps>
|
|
|
|
Utilisez l'URL `.mintlify.site` pendant le POC. L'authentification fonctionne sur un [domaine personnalisé](/fr/customize/custom-domain) ou votre sous-domaine `.mintlify.site`, mais ne fonctionne pas sur un sous-chemin personnalisé tel que `yourcompany.com/docs`. Consultez [Configuration de l'authentification](/fr/deploy/authentication-setup).
|
|
|
|
<div id="step-2-invite-your-team">
|
|
## Étape 2 : inviter votre équipe
|
|
</div>
|
|
|
|
Ouvrez la page [Membres](https://app.mintlify.com/settings/organization/members) et attribuez à chaque participant le rôle le plus restreint dont il a besoin :
|
|
|
|
- **Admin :** gère les paramètres de l'organisation, la facturation et les intégrations.
|
|
- **Editor :** crée et publie du contenu.
|
|
- **Viewer :** consulte le tableau de bord et les analyses sans pouvoir modifier.
|
|
|
|
Consultez [Rôles](/fr/dashboard/roles) pour la liste complète des autorisations.
|
|
|
|
Invitez au moins un rédacteur qui n'utilise pas Git, un ingénieur et le décideur. Utilisez leurs adresses e-mail professionnelles afin que leurs comptes puissent se connecter à votre fournisseur d'identité si vous testez l'authentification.
|
|
|
|
<div id="step-3-add-sample-content">
|
|
## Étape 3 : ajouter du contenu d'exemple
|
|
</div>
|
|
|
|
<div id="choose-representative-pages">
|
|
### Choisir des pages représentatives
|
|
</div>
|
|
|
|
Commencez par vos 20 à 30 pages les plus consultées. Incluez :
|
|
|
|
- Votre page de référence d'API la plus complexe.
|
|
- Une page contenant un grand tableau ou une liste profondément imbriquée.
|
|
- Une page contenant des images, des vidéos ou des diagrammes.
|
|
- Une page contenant des composants personnalisés ou des widgets intégrés.
|
|
- Deux ou trois guides typiques.
|
|
|
|
Limitez l'échantillon à moins de 50 pages pour pouvoir vous concentrer sur la qualité de la migration.
|
|
|
|
<div id="move-the-content">
|
|
### Déplacer le contenu
|
|
</div>
|
|
|
|
<Tabs>
|
|
<Tab title="Utiliser les services de migration Mintlify">
|
|
Demandez à votre AE ou SE si la migration est incluse dans votre POC. Si c'est le cas, envoyez :
|
|
|
|
- L'URL ou l'export de votre documentation actuelle.
|
|
- Votre liste de pages d'exemple.
|
|
- Votre fichier ou URL OpenAPI, le cas échéant.
|
|
- Vos éléments de marque.
|
|
|
|
Consultez [Migrations entreprise](/fr/migration-services/enterprise) pour le processus de migration complet.
|
|
</Tab>
|
|
|
|
<Tab title="Migrer vous-même">
|
|
Utilisez l'une de ces méthodes :
|
|
|
|
1. Exportez du Markdown depuis votre plateforme actuelle. Suivez le guide de migration pour [Docusaurus](/fr/migration/docusaurus), [ReadMe](/fr/migration/readme), [GitBook](/fr/migration/gitbook), [Fern](/fr/migration/fern) ou [Document360](/fr/migration/document360).
|
|
2. Collez un petit nombre de pages dans l'éditeur web et nettoyez la mise en forme.
|
|
3. Convertissez le contenu avec un outil d'IA en utilisant la [skill](/fr/ai/skillmd) Mintlify et le [serveur MCP d'administration](/fr/ai/mintlify-mcp).
|
|
|
|
Consultez [Migrer vers Mintlify](/fr/migration) pour les autres plateformes.
|
|
</Tab>
|
|
|
|
<Tab title="Connecter une source de contenu existante">
|
|
Si votre contenu source se trouve dans Notion, Confluence, Jira ou un outil similaire, connectez-le à l'agent Mintlify. Consultez [Intégrations pour l'agent et les automatisations](/fr/automations/integrations).
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<div id="review-the-migration">
|
|
### Vérifier la migration
|
|
</div>
|
|
|
|
Comparez chaque page d'exemple avec sa source. Vérifiez :
|
|
|
|
- Les images, les tableaux et les exemples de code.
|
|
- Les liens internes et externes.
|
|
- Les composants personnalisés et les contenus intégrés.
|
|
- Les libellés de navigation et l'emplacement des pages.
|
|
|
|
Confirmez qu'un nouvel utilisateur peut atteindre une page utile en deux clics et que les libellés de navigation utilisent des termes que les lecteurs sont susceptibles de rechercher. Envoyez les problèmes de migration à votre AE ou SE dans une seule liste, avec l'URL de la page et le résultat attendu.
|
|
|
|
<div id="step-4-publish-a-change">
|
|
## Étape 4 : publier une modification
|
|
</div>
|
|
|
|
Demandez à un rédacteur qui n'utilise pas Git de réaliser cette étape.
|
|
|
|
<Steps>
|
|
<Step title="Créer une branche">
|
|
Ouvrez l'[éditeur web](https://app.mintlify.com/editor). Cliquez sur le nom de la branche dans la barre d'outils de l'éditeur, sélectionnez **Create new branch**, saisissez un nom, puis cliquez sur **Create branch**.
|
|
|
|
Une branche garde le brouillon séparé de votre site déployé.
|
|
</Step>
|
|
|
|
<Step title="Modifier une page">
|
|
Modifiez la page dans l'éditeur visuel. Tapez `/` pour insérer un composant ou faites glisser une image sur la page pour la téléverser.
|
|
|
|
Appuyez sur <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (macOS) ou <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (Windows) pour basculer entre le mode visuel rendu et la source MDX.
|
|
</Step>
|
|
|
|
<Step title="Partager l'aperçu">
|
|
Sélectionnez **Create pull request**. Mintlify génère un [déploiement d'aperçu](/fr/editor/review#preview-deployments) : une URL temporaire où vos modifications s'affichent exactement comme elles apparaîtront une fois publiées. Copiez l'URL et envoyez-la à un relecteur. Apportez les modifications demandées sur la même branche. L'aperçu est reconstruit à chaque enregistrement.
|
|
</Step>
|
|
|
|
<Step title="Publier">
|
|
Fusionnez la pull request pour déployer la modification sur votre site en ligne. Publier depuis votre branche de déploiement déploie la modification immédiatement, sans pull request. Consultez [Publier des modifications](/fr/editor/publish).
|
|
|
|
Confirmez que le commit apparaît sur la page **Overview** du tableau de bord et que la modification approuvée apparaît sur votre site.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Conserver vos contrôles de revue existants">
|
|
Les modifications faites dans l'éditeur créent des commits Git ; CODEOWNERS, les revues obligatoires et la protection des branches continuent donc de s'appliquer.
|
|
</Accordion>
|
|
|
|
<Accordion title="Travailler en Markdown ou en local">
|
|
Les rédacteurs peuvent rester dans la vue Markdown de l'éditeur. Les ingénieurs peuvent installer la [CLI](/fr/cli/install), cloner le dépôt et exécuter [`mint dev`](/fr/cli/preview) en local.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
Vous pouvez aussi tester les [déploiements d'aperçu](/fr/deploy/preview-deployments) pour les pull requests ou [ajouter l'agent à Slack](/fr/agent/slack#connect-your-slack-workspace) pour proposer des modifications de documentation depuis Slack.
|
|
|
|
<div id="step-5-apply-branding">
|
|
## Étape 5 : appliquer votre image de marque
|
|
</div>
|
|
|
|
Mettez à jour les paramètres de votre marque dans `docs.json` :
|
|
|
|
```json docs.json
|
|
{
|
|
"theme": "luma",
|
|
"colors": {
|
|
"primary": "#16A34A",
|
|
"light": "#07C983",
|
|
"dark": "#15803D"
|
|
},
|
|
"logo": {
|
|
"light": "/logo/light-logo.svg",
|
|
"dark": "/logo/dark-logo.svg"
|
|
},
|
|
"favicon": "/favicon.svg"
|
|
}
|
|
```
|
|
|
|
Ensuite :
|
|
|
|
1. Vérifiez que les liens et les boutons restent lisibles en mode clair et en mode sombre.
|
|
2. Ajoutez vos polices via les [paramètres de police](/fr/customize/fonts).
|
|
3. Ajoutez une image Open Graph par défaut et testez un lien partagé dans Slack.
|
|
|
|
Consultez les [paramètres d'apparence](/fr/organize/settings-appearance), les [thèmes](/fr/customize/themes) et le [SEO](/fr/optimize/seo) pour les autres options. Si vous ne souhaitez pas modifier `docs.json`, envoyez vos éléments de marque à votre AE ou SE.
|
|
|
|
<div id="step-6-test-ai-features">
|
|
## Étape 6 : tester les fonctionnalités d'IA
|
|
</div>
|
|
|
|
<div id="configure-the-assistant">
|
|
### Configurer l'assistant
|
|
</div>
|
|
|
|
Ouvrez la page [Assistant](https://app.mintlify.com/products/assistant) :
|
|
|
|
1. Activez l'assistant.
|
|
2. Ajoutez des [e-mails de redirection](/fr/assistant/configure#set-deflection-emails) pour les questions nécessitant une aide humaine.
|
|
3. Ajoutez jusqu'à trois [questions de démarrage](/fr/assistant/configure#add-sample-questions).
|
|
4. Ajoutez des [domaines de recherche](/fr/assistant/configure#search-domains) si du contenu pertinent est réparti sur plusieurs sites.
|
|
5. Laissez la [protection contre les bots](/fr/assistant/configure#bot-protection) activée.
|
|
|
|
Consultez [Personnaliser l'assistant](/fr/assistant/customize) et [Compétences de l'assistant](/fr/assistant/skills) pour des instructions spécifiques au produit et le ton des réponses.
|
|
|
|
<div id="test-real-questions">
|
|
### Tester des questions réelles
|
|
</div>
|
|
|
|
1. Rassemblez 20 à 30 questions récentes issues des tickets de support ou des canaux communautaires.
|
|
2. Posez chaque question via **Ask Assistant** sur votre site.
|
|
3. Notez si la réponse est correcte et si elle cite la bonne page.
|
|
4. Utilisez les réponses erronées ou manquantes pour identifier les pages à mettre à jour ou à créer.
|
|
|
|
Passez en revue les questions sans réponse et celles ayant reçu un vote négatif dans les [analyses de l'assistant](/fr/analytics/assistant). Si une page pertinente n'est pas citée, rendez sa `description` de frontmatter spécifique et unique.
|
|
|
|
<div id="test-one-additional-ai-workflow">
|
|
### Tester un workflow d'IA supplémentaire
|
|
</div>
|
|
|
|
Choisissez le workflow le plus pertinent pour votre évaluation :
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Intégrer l'assistant">
|
|
Ajoutez le [widget de l'assistant](/fr/assistant/widget) à votre produit, à votre site marketing ou à votre portail d'assistance.
|
|
</Accordion>
|
|
|
|
<Accordion title="Connecter des outils d'IA">
|
|
Utilisez le [serveur MCP de recherche](/fr/ai/model-context-protocol) pour rendre le contenu publié disponible dans les outils d'IA pris en charge. Utilisez le [serveur MCP d'administration](/fr/ai/mintlify-mcp) pour rédiger et modifier la documentation.
|
|
|
|
Vous pouvez aussi tester le [menu contextuel](/fr/ai/contextual-menu), [`llms.txt`](/fr/ai/llmstxt), [`skill.md`](/fr/ai/skillmd) et l'[export des pages en Markdown](/fr/ai/markdown-export).
|
|
</Accordion>
|
|
|
|
<Accordion title="Automatiser une tâche de maintenance">
|
|
Activez une [automatisation](/fr/automations), comme la rédaction d'un changelog ou la mise à jour de la documentation après une modification du code. Commencez avec **Require review**, puis examinez la pull request proposée et l'historique des exécutions. Consultez [Gérer les automatisations](/fr/automations/manage).
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
<div id="step-7-review-results">
|
|
## Étape 7 : passer en revue les résultats
|
|
</div>
|
|
|
|
Réservez une heure avec votre décideur. Commencez par l'objectif et la valeur de référence définis avant le POC, puis passez en revue :
|
|
|
|
| Critère | Preuve |
|
|
|---|---|
|
|
| Un non-développeur peut publier | Le résultat de l'étape 4 et le temps nécessaire. |
|
|
| Les ingénieurs gardent le contrôle des revues | La pull request et ses vérifications. |
|
|
| Le contenu complexe migre correctement | Les pages d'exemple comparées côte à côte. |
|
|
| L'assistant répond avec précision | Vos questions notées et les pages citées. |
|
|
| Les lacunes de contenu sont identifiables | Les questions sans réponse et avec vote négatif dans les [analyses de l'assistant](/fr/analytics/assistant). |
|
|
| Les lecteurs trouvent du contenu utile | Les données de [trafic](/fr/analytics/traffic), de [recherche](/fr/analytics/search) et d'[engagement](/fr/analytics/user-engagements). |
|
|
| Les mises à jour automatisées sont utiles | L'historique des exécutions de l'automatisation et la modification proposée. |
|
|
|
|
Résolvez les questions en suspens avec votre AE ou SE avant cette réunion.
|
|
|
|
<div id="suggested-timeline">
|
|
## Calendrier suggéré
|
|
</div>
|
|
|
|
La plupart des POC durent deux à trois semaines :
|
|
|
|
| Semaine | Priorité |
|
|
|---|---|
|
|
| Semaine 1 | Connecter le dépôt, inviter votre équipe, définir la réussite et démarrer la migration du contenu. Commencer la configuration du domaine si vous avez besoin de l'authentification. |
|
|
| Semaine 2 | Vérifier le contenu, publier une modification, appliquer l'image de marque, tester l'assistant et évaluer un workflow d'IA. |
|
|
| Semaine 3 | Passer en revue les résultats avec votre décideur. |
|
|
|
|
<div id="getting-help">
|
|
## Obtenir de l'aide
|
|
</div>
|
|
|
|
- Contactez votre AE ou SE pour les questions urgentes liées au POC.
|
|
- Écrivez à [support@mintlify.com](mailto:support@mintlify.com) pour toute autre question.
|
|
- Consultez [Support avancé](/fr/advanced-support) pour les options de support après le POC.
|
|
|
|
<div id="after-the-poc">
|
|
## Après le POC
|
|
</div>
|
|
|
|
<Card title="Liste de contrôle de mise en ligne" icon="file-check" horizontal href="/fr/migration-services/go-live-checklist">
|
|
Passez en revue tout ce qu'il faut configurer et vérifier avant le lancement.
|
|
</Card>
|