Créer un centre de recherche pour la documentation
Un centre de recherche pour la documentation offre aux lecteurs un endroit unique où poser leurs questions de mise en œuvre à travers une sélection de guides. Construisez-le autour du périmètre de documentation maintenu, et non de l’ensemble du site de l’entreprise.
Définir le périmètre de la documentation
Listez les versions, produits et publics que la page doit couvrir. Excluez les anciennes versions, les procédures internes, les doublons générés, les pages de compte et les contenus marketing qui ne répondent pas aux questions de mise en œuvre.
Si plusieurs versions doivent rester consultables, rendez la version visible dans les titres et dans le texte source. Sinon, une réponse correcte pour une ancienne version peut sembler actuelle.
Capturer et inspecter la documentation
Configurez une tâche de capture de site web pour le nom d’hôte et les chemins de la documentation. Réglez avec soin la profondeur d’exploration, les chemins inclus et les exclusions.
Après le traitement, vérifiez dans le jeu de données :
- les titres de pages connus et les termes liés au code ;
- les URL canoniques correctes ;
- les procédures et prérequis complets ;
- les numéros de version ;
- les pages de navigation ou d’impression en double ; et
- les sections obsolètes à supprimer.
Créer le centre de recherche
Sélectionnez le jeu de données de documentation lors de la création. Utilisez un titre et une description qui indiquent le produit et la version couverts.
Ajoutez des suggestions basées sur des tâches, par exemple :
- « Comment configurer les origines autorisées ? »
- « Quels types de fichiers puis-je importer ? »
- « Comment planifier une capture récurrente ? »
- « Que vérifier quand l’intégration ne s’affiche pas ? »
Chaque suggestion doit correspondre à une page maintenue qui contient la réponse.
Tester la navigation à travers les réponses
Utilisez une grille de tests qui inclut des noms exacts de fonctionnalités, des descriptions de problèmes, des questions propres à une version et des demandes non couvertes. Vérifiez à la fois la réponse et le passage cité.
Pour les réponses procédurales, assurez-vous que les prérequis et l’ordre des étapes restent intacts. Pour le dépannage, vérifiez que le résultat cite la page correspondant au symptôme réel plutôt qu’une page d’accueil générale de la documentation.
Synchroniser les changements de version
Définissez un calendrier de capture qui suit le processus de publication de la documentation. Après une nouvelle version, vérifiez une information modifiée dans la source, dans l’enregistrement du jeu de données et dans la réponse du centre de recherche.
Le centre de recherche est une couche d’accès à la documentation. La responsabilité de la documentation, la gestion des versions et la qualité des sources restent le socle.