Brouillons automatiques de PR
Activez les brouillons automatiques de PR dans Paramètres > Automatisations pour que Fern prépare une mise à jour de la documentation lorsqu’une pull request fusionnée modifie un comportement visible par les clients. Vous examinez toujours chaque brouillon avant de le publier ou de l’ignorer ; Fern ne publie jamais automatiquement.
Avant de commencer
Connectez l’intégration GitHub afin que Fern puisse surveiller les pull requests dans vos dépôts.
Activer les brouillons automatiques de PR
Ouvrez les Paramètres dans la barre latérale du tableau de bord.
Sélectionnez Automatisations. La page comprend les brouillons automatiques de PR, les audits planifiés et la vérification continue.
Activez les brouillons automatiques de PR. Le paramètre est enregistré immédiatement.
Lorsque l’option est activée, les sections Sensibilité et Instructions pour les brouillons de PR apparaissent en dessous.
Choisir la sensibilité
Utilisez la Sensibilité pour contrôler la facilité avec laquelle Fern crée un brouillon à partir d’une pull request fusionnée. Choisissez une option :
Stricte : uniquement les changements évidents : Fern prépare un brouillon uniquement lorsque les raisons de mettre à jour la documentation sont les plus convaincantes.
Équilibrée : option par défaut. Fern prépare des brouillons pour les changements clairement visibles par les clients et ignore les changements moins évidents.
proactive : davantage de brouillons : Fern crée des brouillons pour un éventail plus large de changements visibles par les clients.
La modification du sélecteur est enregistrée immédiatement.
La sensibilité ne garantit pas la création d’un brouillon pour chaque changement visible du produit. Fern détermine toujours si la fusion nécessite une documentation, puis applique votre paramètre de sensibilité avant de créer une tâche de rédaction.
Ajouter des instructions pour les brouillons de PR
Utilisez les Instructions pour les brouillons de PR pour définir les consignes permanentes applicables à toute l’organisation que Fern applique lorsqu’il examine les pull requests fusionnées et crée des brouillons à partir de celles-ci.
Le champ accepte jusqu’à 4 000 caractères. Quittez le champ pour enregistrer. Des instructions vides effacent le paramètre.
Ce champ est distinct des instructions générales pour Fern définies sous Paramètres > À propos de vous, dans le champ Informations sur l’entreprise. Ces instructions orientent la rédaction et la recherche générales de Fern. Les Instructions pour les brouillons de PR s’appliquent uniquement à l’examen des PR et aux brouillons générés à partir des PR.
Ce qui déclenche un brouillon
Fern crée un brouillon à partir d’une pull request après sa fusion dans la branche de production configurée du dépôt. Si aucune branche de production n’est définie, Fern utilise la branche par défaut du dépôt. Les pull requests fusionnées dans d’autres branches sont ignorées. Les pull requests de réversion sont également ignorées.
Définissez la branche de production de chaque dépôt sur la page de l’intégration GitHub.
Fern crée un brouillon lorsque la fusion modifie un comportement visible par les clients dont ils doivent être informés, comme des parcours d’interface, des points de terminaison d’API, le comportement d’une fonctionnalité, des messages d’erreur ou des options de configuration, et que le changement respecte votre paramètre de sensibilité.
Fern ne crée pas de brouillon lorsque :
Le changement est interne ou n’a aucun impact sur les utilisateurs finaux
La documentation concernée est déjà à jour
Le changement est visible par les clients, mais ne respecte pas votre paramètre de sensibilité actuel
Dans ces cas, Fern enregistre tout de même une modification de code marquée Aucune modification de documentation nécessaire. Ces discussions n’apparaissent pas dans la liste Tous par défaut. Filtrez la page Fern par Automatisations pour les examiner. Ouvrez une discussion pour voir le titre et les éventuelles explications enregistrées par Fern.
Examiner vos brouillons
Lorsqu’il crée un brouillon, Fern l’affiche sur votre page Fern sous la forme d’une discussion accompagnée d’une icône de pull request. La discussion affiche le titre et les métadonnées de la PR, un résumé des changements et l’état du brouillon.
Pour filtrer la page Fern, ouvrez Filtrer les discussions dans l’en-tête de la barre latérale. L’option Contient des brouillons n’affiche que les discussions de tâches pouvant être examinées ; elle peut donc ne pas inclure la discussion de modification de code de la PR elle-même. Ouvrez directement la discussion de la PR ou sélectionnez la pastille Automatisations pour la trouver.
Ouvrez la discussion. Lorsque le brouillon est prêt, choisissez Examiner et modifier les changements. Modifiez le brouillon, demandez des révisions dans la discussion ou publiez-le lorsque vous êtes satisfait.
Vous contrôlez la publication
Fern prépare les mises à jour, mais ne les publie jamais automatiquement. Chaque brouillon doit être examiné par vos soins avant d’apparaître dans votre centre d’aide.
Ignorer un brouillon comme non pertinent
Lorsqu’un brouillon ne concerne pas votre centre d’aide, marquez-le comme Non pertinent pour le retirer de votre flux sans le publier. Vous pouvez ignorer tout brouillon éligible qui attend encore un examen ; les changements publiés ou en cours de publication ne peuvent pas être ignorés.
Ouvrez le brouillon sur votre page Fern.
Sélectionnez Non pertinent.
Ajoutez une raison si vous souhaitez vous rappeler pourquoi il ne s’appliquait pas (facultatif).
Confirmez l’ignorance.
Le brouillon est fermé et disparaît de votre flux Fern principal. Il n’est pas supprimé : filtrez le flux par Automatisations pour retrouver les changements ignorés. Un changement ignoré affiche Ignoré comme non pertinent, ainsi que la raison enregistrée, le cas échéant, et aucune option d’examen ou de publication.