Tout réécrire, c'est ainsi que la documentation perd sa voix
Quand on corrige une documentation périmée à grande échelle, les pages sont en général réécrites de zéro. Cette réécriture complète perd ce qui rendait la page digne d'être gardée : l'exemple auquel quelqu'un a passé un après-midi, l'avertissement ajouté après une demande de support, ou le libellé qu'un client vous a renvoyé.
Les corrections utiles sont étroites : un nom de paramètre, une valeur par défaut, et une étape qui se fait désormais dans un autre ordre. Le reste de la page reste tel que l'auteur d'origine l'a écrit.
Pour trouver cette petite correction, on lit le code et la page, puis on repère la phrase précise qui est fausse. Cette tâche est plus difficile que de régénérer la page. À ce niveau de détail, l'agent propose des modifications et les montre comme un diff qu'un mainteneur peut examiner en une minute. Rien n'est publié. La personne qui possède la page décide.
Comment l'agent est construit dans Agent Studio
Les prompt skills portent la propriété de la documentation, votre guide de style, et les pages que vous avez délibérément marquées comme simplifiées, qui ne doivent jamais être corrigées pour l'exactitude.
Le prompt système exige que chaque modification soit aussi petite que possible, et qu'elle cite à la fois la phrase d'origine et le code qui la contredit.
Il interdit les restructurations, les changements de ton, et toute modification autre qu'une correction. Les améliorations auxquelles l'agent pense vont dans une note, pas dans le diff.
Si la contradiction ne peut pas se déduire du code fourni, l'agent laisse la section inchangée. Il ne modifie pas à partir d'une conjecture.
Le nœud GitHub fournit le code changé et la source de la documentation. Le nœud Agent Chat lit les deux. Le changement précis est la question.
Les modifications proposées sont soumises comme pull request via le nœud GitHub, une pull request par page, avec la contradiction dans la description.
Aucune fusion n'a lieu. Un nœud Human in the Loop envoie chaque pull request au propriétaire de la page. Les pages marquées comme simplifiées n'entrent jamais dans la file.
De quoi cet agent est constitué
- Prompt skills : propriété, guide de style, et pages délibérément laissées simplifiées.
- System prompt : modifications minimales, avec la phrase et le code contradictoire cités.
- System prompt : pas de restructuration, pas de changement de ton. Les améliorations vont dans une note.
- System prompt : aucune modification là où la contradiction ne peut pas être établie.
- GitHub (Integration) : le code changé et la source de la documentation ensemble.
- Agent Chat (Util) : lit les deux, le changement précis étant la question.
- Quand un ActionFlow suffit : Si vous n'avez besoin que de signaler les sections qu'un changement contredit, construisez le flux de travail. Beaucoup d'équipes ne veulent que le signalement.
Questions fréquentes
Newsletter
Recevoir les mises à jour produit
Nouveaux nœuds, agents et notes produit. Nous n'envoyons un e-mail que lorsqu'il vaut la peine de l'ouvrir.