Recherche IA dans la documentation
Les lecteurs de documentation savent souvent ce qu’ils veulent faire, mais pas le nom de la page qui l’explique. La recherche IA dans la documentation peut comprendre la tâche formulée avec leurs propres mots et renvoyer une réponse fondée sur la documentation indexée.
Elle doit compléter une navigation claire et une recherche exacte, pas masquer la documentation.
Partez des tâches, pas du nombre de pages
Rassemblez les questions issues des tickets de support, de la recherche interne du site, de l’onboarding et des retours des développeurs. Associez chaque question à la page qui doit y répondre.
Par exemple :
- « Où dois-je autoriser mon domaine ? »
- « Comment actualiser les pages capturées ? »
- « Quels formats de fichiers puis-je importer ? »
- « Pourquoi l’assistant ne s’affiche-t-il pas sur mon site ? »
Si une question nécessite des informations dispersées sur plusieurs pages, décidez s’il faut regrouper la documentation ou si une réponse combinée et sourcée est réellement utile.
Délimitez la documentation à capturer
Configurez la tâche de capture de données du site web avec le nom d’hôte de la documentation et le chemin pertinent. Excluez les anciennes versions, les index générés, les pages de compte et les contenus internes.
Examinez les liens découverts et le contenu du jeu de données avant de connecter l’expérience visiteur.
Choisissez la bonne interface
Un centre de recherche convient lorsque la recherche est la tâche principale de la documentation et mérite sa propre URL publique. Un assistant intégré convient lorsque les lecteurs doivent pouvoir poser des questions sans quitter le guide en cours.
Dans les deux cas, affichez les liens vers les sources afin que les lecteurs puissent consulter les prérequis, le code, les avertissements et le contexte.
Testez l’utilité des réponses
| Test | Condition de réussite |
|---|---|
| Formulation de la tâche | La terminologie du lecteur renvoie au bon guide |
| Configuration exacte | Les valeurs et les libellés de l’interface correspondent à la source |
| Procédure en plusieurs étapes | La réponse respecte l’ordre documenté |
| Question de version | La version actuelle est utilisée |
| Intégration non prise en charge | La réponse n’invente pas de compatibilité |
| Citation | Le lien ouvre la page contenant l’information indiquée |
Conservez la recherche exacte par mots-clés pour les identifiants, les codes d’erreur, les méthodes d’API et les titres de pages connus. Les réponses directes et la recherche classique répondent à des besoins documentaires différents.
Analysez les conversations pour repérer les pages manquantes et la terminologie déroutante, puis améliorez la documentation et capturez-la de nouveau.