Une page peut avoir des années et rester juste
La documentation se périme en silence et se fait auditer par date, ce qui signale les pages que personne n'avait besoin de changer et manque la page devenue fausse mardi dernier.
L'âge est un mauvais substitut. Une page conceptuelle écrite il y a deux ans peut être parfaitement exacte, tandis qu'un démarrage rapide édité le mois dernier peut être faux parce qu'une valeur par défaut a changé en dessous.
L'erreur est une relation entre deux choses : ce que le code fait maintenant et ce que la page dit qu'il fait. Le vérifier, c'est lire les deux. La lecture est étroite : noms de paramètres, valeurs par défaut, formes de retour, et ordre exigé.
Signaler avec la contradiction citée, c'est ce qui rend cela utilisable. Une liste de pages éventuellement périmées se fait ignorer. Une liste qui dit que cette ligne dit X et que le code fait désormais Y se fait corriger.
Comment l'ActionFlow s'exécute sur le canevas
Deux entrées alimentent le flux. Un nœud GitHub fournit les changements fusionnés depuis le dernier contrôle. Un nœud Notion ou HTTP Request fournit les pages de documentation publiées.
Un nœud Filter resserre les changements à ceux qui touchent une surface publique (signatures, valeurs par défaut, configuration, types publics), parce qu'une restructuration interne ne peut pas rendre une page fausse.
Un nœud Loop parcourt les changements restants. Pour chacun, un nœud Generate Object renvoie les passages de documentation qui décrivent le comportement changé, cités.
Un second passage Generate Object juge chaque passage contre le changement et renvoie l'un de trois états : contredit avec la citation, incomplet, ou non touché.
La réponse à trois états, c'est ce qui tient le résultat court. La plupart des passages reviennent non touchés et n'atteignent personne.
Un nœud Filter garde les constats contredits et incomplets. Un nœud Sort met les contradictions en premier, parce que ce sont celles qui induisent activement les lecteurs en erreur.
Un nœud GitHub ouvre un ticket par page touchée, portant la citation et le changement. Un nœud Slack publie le décompte dans le canal documentation.
Le flux ne modifie aucune page. La correction est faite par une personne, la contradiction devant elle.
Nœuds utilisés par cet ActionFlow
- GitHub (Integration) : les changements fusionnés depuis le dernier contrôle.
- Notion (Integration) avec HTTP Request (Util) : les pages de documentation telles que publiées.
- Filter (Data) : resserre aux changements qui touchent une surface publique.
- Loop (Control) : un passage par changement plutôt qu'un passage sur tout.
- Generate Object (AI Core) : les passages qui décrivent le comportement changé, cités.
- Generate Object (AI Core) : contredit, incomplet ou non touché, par passage.
- Sort (Data) : contradictions d'abord.
- GitHub (Integration) : un ticket par page touchée, portant citation et changement.
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.