Colay / Guides

Réécrire un article de la base de connaissances sans perdre ses instructions

Une réécriture de la base de connaissances devrait rendre plus claire la prochaine action du lecteur. Dans Colay, plusieurs brouillons d'IA peuvent révéler si un article fonctionne mieux sous forme de procédure courte, d'arbre de dépannage ou d'explication avec des exemples. Commencez par un article et une fiche d’information vérifiée. Votre livrable est un article révisé avec des instructions traçables, et non une collection de paraphrases attrayantes.

Donnez à l'article un lecteur et un travail

Un article sur la modification des paramètres de notification peut actuellement mélanger la configuration du compte, les autorisations et le dépannage. Avant de réécrire, indiquez le point de départ du lecteur et le résultat qu'il doit atteindre. Mettez tout le reste dans les prérequis, les liens connexes ou un article séparé. Ce choix éditorial compte souvent plus que le changement de ton.

Créez une fiche de tâche : identifiant de l'article, audience, version du produit prise en charge, rôle requis, étiquettes d'interface exactes, résultat attendu, exceptions connues et responsable. Utilisez uniquement du matériel approuvé. Si une étape est incertaine, étiquetez-la pour vérification plutôt que de demander à un modèle de combler le vide de la mémoire. Les instructions de procédure de Google prennent en charge les étapes axées sur l'action et suffisamment de contexte pour localiser l'action.

Une réécriture fictive avec des faits fixes sur les produits

Envisagez un outil d'espace de travail fictif. Les membres peuvent désactiver les notifications personnelles par e-mail dans Paramètres → Notifications. Seul un propriétaire peut modifier les paramètres par défaut à l'échelle de l'organisation. Le paramètre enregistré affecte les futurs e-mails ; il ne supprime pas les messages déjà mis en file d'attente. Ce sont des entrées inventées pour l'exemple, pas des fonctionnalités Colay.

Demandez des structures distinctes utilisant les mêmes faits. Une procédure aide quelqu'un à accomplir la tâche immédiatement ; une version de dépannage aide quelqu'un qui ne trouve pas le contrôle. Une FAQ peut expliquer l'exception des e-mails en file d'attente. Huit approches demandées sont possibles, mais elles doivent aborder huit situations de lecture plutôt que multiplier les mêmes phrases.

Choisir la structure par obstacle du lecteur
Situation des lecteursFormat utileFait qui doit survivre
Je sais ce que je veux changerProcédure numérotéeParamètres → Notifications est le chemin fourni
Je ne parviens pas à modifier les paramètres par défaut de l'organisationDépannage basé sur les rôlesSeul un propriétaire dispose de l'autorisation indiquée
J’ai désactivé les e-mails mais j’en ai reçu un autreCourte explication avec exceptionLes messages en file d'attente ne sont pas affectés

Une invite qui sépare le texte de la vérité du produit

Utilisez Ask separately dans Colay pour voir comment les agents sélectionnés interprètent la tâche. Comparez leurs grandes lignes avant d’affiner des articles entiers. Si une réponse supprime l'exigence d'autorisation tandis que d'autres la conservent, inspectez la source approuvée. L'accord ne remplace pas le test du flux de travail documenté.

Réécrivez cet article approuvé de la base de connaissances : [texte]. Fiche de tâche : [audience, version du produit, rôle, étiquettes exactes de l'interface utilisateur, résultat attendu, exceptions]. Produisez un guide pratique numéroté, une version de dépannage et une version courte de la FAQ. Préservez chaque condition, autorisation et exception. N’inventez pas de contrôles ou de comportements. Pour chaque version, indiquez la phrase source soutenant chaque instruction. Mettez les sources peu claires ou contradictoires dans une liste de questions distincte. Recommandez une structure pour [situation du lecteur] et expliquez le choix. Ne combinez pas silencieusement les faits de différentes versions de produits.

Transformez le meilleur brouillon en une révision publiable

L'artefact final peut être petit : titre approuvé, prérequis, procédure, résultat attendu, exceptions et un lien suivant pertinent. Conservez le mappage source-instruction avec les notes éditoriales. Colay aide à rédiger et à comparer ; ce workflow n'implique pas qu'il puisse se connecter à votre base de connaissances ou publier automatiquement les modifications.

  1. Choisissez la structure qui correspond à la fiche de tâche. Ne conservez les phrases utiles d'autres brouillons qu'après avoir vérifié leur signification.
  2. Parcourez chaque étape de la version du produit prise en charge avec le rôle indiqué. Vérifiez les étiquettes, l'ordre, le résultat et l'exception documentée.
  3. Lisez l'article en tant que nouvel utilisateur : les prérequis doivent apparaître avant qu'ils ne soient nécessaires, et une étape échouée doit avoir une action suivante disponible.
  4. Enregistrez le réviseur, la version de l'article et les sections modifiées. Publiez via le workflow de votre base de connaissances existante, en conservant la version précédente à des fins de comparaison.

Jugez la réécriture par ce qu'un lecteur peut faire

Demandez à un collègue qui ne connaît pas le brouillon de trouver le point de départ, d'identifier son exigence d'autorisation et d'expliquer ce qui se passe après la dernière étape. Enregistrez les malentendus comme des problèmes d’édition. Si vous avez des commentaires ou des données de recherche pour cet article, comparez les mêmes signaux après la publication sans attribuer chaque changement à l'IA. Arrêtez de générer lorsque le travail restant est un fait manquant sur le produit, et non un choix de formulation.

Questions, réponses

Les huit versions doivent-elles être publiées ?

En général, non. Ce sont des propositions pour une même tâche du lecteur. Publiez la version adaptée la plus claire ; créez des articles distincts seulement s’ils répondent à des besoins réellement différents.

Le modèle peut-il réparer des instructions obsolètes ?

Uniquement lorsque vous fournissez des informations de remplacement vérifiées. Un nouveau nom de bouton plausible ne constitue pas une preuve que le produit se comporte de cette façon.

Que se passe-t-il si l'article contient des exemples de clients privés ?

Utilisez uniquement les exemples que vous êtes autorisé à partager. Supprimez les identifiants inutiles et remplacez-les par un exemple fictif où l'identité n'ajoute aucune valeur pédagogique.

Sources et méthodologie

  1. Google: writing procedures

    Des conseils principaux sur les étapes d'action et le contexte clairs ; le flux de travail fictif et la méthode de révision sont les exemples de cet article.

Posez votre prochaine question à Colay

Choisissez un modèle, utilisez Auto ou rassemblez plusieurs perspectives avec Consensus.

Réécrire mon article