Comment Fern crée des articles
Fern est votre agent de documentation IA qui recherche, rédige et prépare des articles pour votre centre d’aide. Vous lui donnez une consigne et elle s’occupe du reste.
Ce guide explique comment le processus fonctionne, quelles sources Fern utilise et comment obtenir les meilleurs résultats.
Comment cela fonctionne
La création d’un article avec Fern suit ce processus :
Donnez une consigne à Fern - Accédez à la page Fern ou appuyez sur ⌘K depuis n’importe quelle page Ferndesk. Saisissez ce dont vous avez besoin (par exemple, « Documenter la fonctionnalité des webhooks » ou « Rédiger un guide de configuration du SSO »).
Fern effectue ses recherches - Elle analyse votre base de code, vos tickets d’assistance, vos articles existants, ainsi que les fichiers ou liens que vous lui fournissez. Vous verrez le détail de ses recherches.
Fern planifie le travail - Elle crée une liste de tâches indiquant chaque étape (recherche, rédaction, ajout d’éléments visuels). Vous pouvez ainsi suivre sa progression.
Fern rédige l’article - Elle rédige l’article complet à partir de ses recherches. Le brouillon apparaît dans la visionneuse de tâches avec le statut « Prêt à être relu ».
Vous relisez et publiez - Modifiez le brouillon directement dans la visionneuse de tâches, puis publiez-le dans votre centre d’aide lorsqu’il est prêt.
Fern ne publie rien automatiquement. Vous gardez toujours le contrôle final avant la mise en ligne des articles.
Sources utilisées par Fern
Fern s’appuie sur plusieurs sources pour créer une documentation exacte et complète :
Votre centre d’aide - Recherche dans les articles existants pour éviter les doublons et ajouter des liens pertinents
Conversations avec l’assistance - Analyse les tickets provenant d’Intercom, de Zendesk ou de Help Scout afin d’identifier les questions fréquentes et les difficultés rencontrées
Votre base de code - Parcourt vos dépôts GitHub connectés pour documenter les parcours de l’interface, les routes, les points de terminaison d’API et les messages d’erreur. Si plusieurs dépôts sont connectés, Fern peut se concentrer sur un dépôt ou une branche spécifique lorsque cela est nécessaire.
Fichiers et liens - Lit les PDF, les fichiers texte et la documentation externe que vous joignez à la consigne
Images - Capture et annote des captures d’écran et analyse des diagrammes (elle ne peut pas créer d’illustrations originales, mais uniquement les capturer et les décrire)
Vidéos - Intègre des vidéos publiques provenant de YouTube, Loom, Wistia ou Vimeo. Vous pouvez également importer des vidéos directement.
Navigation web - Recherche dans la documentation externe, les journaux des modifications ou les documents de référence
Connectez des intégrations comme GitHub et Intercom dans les paramètres de votre espace de travail pour permettre à Fern d’accéder à ces sources.
Obtenir les meilleurs résultats
La qualité du résultat de Fern dépend de la quantité de contexte que vous lui fournissez. Voici comment lui donner les meilleures conditions pour réussir :
Rédigez des consignes claires et détaillées
Soyez précis sur ce que vous voulez. Au lieu de « Documenter les webhooks », essayez « Documenter la fonctionnalité des webhooks. Présenter les étapes de configuration, les événements disponibles, le format de la charge utile et le dépannage des erreurs courantes. »
Plus vous fournissez de détails, mieux Fern peut effectuer ses recherches et structurer l’article.
Définissez des instructions globales
Accédez à Paramètres → À propos de vous pour configurer la manière dont Fern rédige et effectue ses recherches :
Instructions de rédaction - Définissez le ton que vous préférez (par exemple, « Utiliser un ton sûr et convivial » ou « Rédiger pour un public technique »)
Instructions de recherche - Indiquez à Fern les éléments à privilégier (par exemple, « Toujours parcourir la base de code pour les parcours de l’interface » ou « Vérifier les tickets d’assistance pour connaître les problèmes courants »)
Ces paramètres s’appliquent à chaque tâche créée par Fern : vous n’avez donc pas besoin de vous répéter.
Joignez des fichiers et des liens
Si vous disposez de documents de référence (spécifications, captures d’écran, vidéos, documentation existante), joignez-les directement à votre consigne. Fern les intégrera à ses recherches.
Utilisez les brouillons et audits automatiques des PR
Lorsque Automatic PR drafts est activé, Fern peut créer des brouillons à partir des pull requests fusionnées qui modifient le comportement visible par les clients. Sensitivity and Guidance for PR drafts dans Settings > Automations détermine la facilité avec laquelle ces brouillons sont créés et les règles permanentes qui s’appliquent. Toutes les PR fusionnées ne donnent pas lieu à une tâche de rédaction.
Fern identifie également les lacunes de la documentation grâce aux audits. Consultez la page Fern pour voir les résultats des audits, puis attribuez directement des tâches afin de rédiger les articles nécessaires.
Travailler avec les brouillons
Lorsque Fern a terminé, le brouillon apparaît dans la visionneuse de tâches. Vous pouvez :
Modifier directement - Utilisez l’éditeur intégré pour affiner le contenu, ajuster la mise en forme ou ajouter des sections
Demander des modifications - Envoyez un message à Fern dans le fil de la tâche pour demander des révisions (par exemple, « Ajouter une section de dépannage » ou « Raccourcir l’introduction »)
Publier lorsque le contenu est prêt - Enregistrez et publiez l’article dans votre collection du centre d’aide
Les brouillons restent dans la visionneuse de tâches jusqu’à leur publication. Rien n’est mis en ligne sans votre approbation.
Les tâches très longues peuvent afficher un séparateur Context compacted dans le fil. Il s’agit d’un comportement automatique qui permet à la tâche de continuer. Vous pouvez développer le séparateur pour consulter le résumé ; le brouillon se poursuit normalement.
Après la publication
Fern ne publie que le contenu dans la langue principale. Si vous avez activé des langues de traduction gérées automatiquement, la suite de traduction met automatiquement en file d’attente les traductions des articles nouvellement publiés. Elles apparaissent peu après la publication, et non instantanément. Pour mettre à jour des traductions existantes, utilisez le sélecteur de langue dans l’éditeur d’articles ou accédez à Help Center > Translate pour retraduire tout le contenu dans cette langue.
Exemples de code dans les brouillons
Les brouillons de Fern peuvent inclure des blocs de code avec coloration syntaxique ainsi que des blocs de code multilingues qui affichent le même extrait dans plusieurs langages, ce qui est utile pour présenter côte à côte des exemples REST et SDK. Pendant la rédaction, Fern peut également rechercher dans vos références d’API publiées afin que les noms des points de terminaison, les méthodes, les paramètres et les réponses des nouveaux guides correspondent à vos spécifications.