Comment fonctionne Fern
Fern rédige des modifications pour le centre d’aide à partir des informations qu’il peut lire sur votre produit. C’est vous qui décidez de leur publication : rien de ce que Fern rédige n’est publié tant qu’un propriétaire ou un administrateur ne l’a pas publié.
Ce que Fern peut lire et modifier
Source | Ce que Fern lit | Ce que Fern modifie |
|---|---|---|
Votre centre d’aide | Articles, collections, références d’API et entrées du journal des modifications, pour pouvoir créer des liens entre les articles associés et éviter les doublons | Rédige de nouveaux articles et de nouvelles entrées du journal des modifications, et prépare des modifications, déplacements et suppressions que vous pourrez examiner |
GitHub | Les dépôts que vous incluez pour la documentation, ainsi que les pull requests qui y sont fusionnées : libellés de l’interface, routes, points de terminaison et messages d’erreur | Rien. Fern ne fait que lire votre code |
Vos outils d’assistance | Les conversations des services d’assistance que vous connectez, pour voir les questions des clients | Rien. Fern n’écrit jamais en retour |
Fichiers et liens | Les PDF, documents, feuilles de calcul, images et vidéos que vous joignez, ainsi que les pages Web et les liens YouTube | Rien |
Le Web | Votre site Web et d’autres pages publiques, comme la documentation d’un autre outil | Rien |
Votre produit | Les écrans accessibles à un compte de test, une fois que vous avez connecté un tableau de bord | Rien. Fern ajoute les captures d’écran à ses brouillons |
Comment une demande devient une modification
Fern fait des recherches avant de rédiger. Il trouve les articles qui traitent déjà du sujet, vérifie le code pour repérer les libellés et les comportements réels, et consulte les conversations d’assistance associées. Ensuite, il rédige dans le style de votre centre d’aide, suit vos instructions et regroupe toutes les modifications dans une seule tâche.
Vous examinez la tâche, modifiez le brouillon ou demandez à Fern d’y apporter des changements, puis vous le publiez. Si vous traduisez automatiquement votre centre d’aide, les traductions sont générées après la publication.
Quand Fern commence à travailler
Lorsque vous le demandez : Demander à Fern de rédiger ou de mettre à jour des articles.
Lorsque vous fusionnez une pull request qui modifie ce que les clients voient : Mettre à jour la documentation lors de la fusion d’une pull request.
Lorsque la vérification détecte qu’un article ne correspond plus à votre produit, ou lorsque vous signalez à Fern une lacune repérée lors d’un audit : Garder les articles à jour.
Fern dans Support
Avec Support, Fern examine également chaque conversation transmise à votre équipe et lui laisse une note, accompagnée d’une réponse provisoire lorsqu’il connaît la réponse. Les propriétaires et les administrateurs peuvent désactiver cette option dans Enquêtes de transfert via Fern > Personnaliser > Général.