How to Maintenir la documentation à jour with Eigent

Comment ça marche

1. Partagez les fichiers source modifiés, la branche, la pull request ou le commit qui doit être documenté.
2. Demandez à Eigent de rechercher dans la documentation existante les noms de fonctionnalités, clés de configuration, commandes et exemples concernés.
3. Mettez à jour uniquement les docs qui doivent changer — conservez la structure des pages, la terminologie, les liens croisés et le frontmatter.
4. Exécutez les vérifications de formatage et de documentation, puis demandez à Eigent de résumer les éléments de preuve derrière chaque affirmation visible par l’utilisateur.
5. Examinez le résumé avant publication pour confirmer qu’aucun contexte interne ou non publié n’a été divulgué dans la documentation publique.

Plus de prompts à essayer

• Quelles pages de documentation existantes font référence au comportement modifié dans cette PR ?
• Ce changement affecte-t-il des paramètres d’API publique, des valeurs par défaut ou des flags CLI qui doivent être mis à jour ?
• Rédigez une entrée de changelog pour cette version qui corresponde à notre format existant.
• Identifiez toute affirmation visible par l’utilisateur dans la documentation mise à jour que vous ne pouvez pas vérifier à partir du code source seul.

Comment l’utiliser

Commencez par le changement que vous devez documenter — partagez la branche, la PR ou le commit. Demandez à Eigent de rechercher dans la documentation existante avant de rédiger quoi que ce soit, afin qu’il mette à jour les bonnes pages plutôt que d’en écrire de nouvelles qui dupliquent le contenu existant. Gardez le périmètre étroit : une note précise ou une mise à jour d’exemple est préférable à une réécriture complète de la page. Pour rendre ce processus répétable, enregistrez le workflow comme une compétence ou demandez à Eigent de l’exécuter selon un calendrier après chaque version.

Résultat attendu

Des fichiers de documentation mis à jour couvrant uniquement les changements visibles par l’utilisateur, un résumé de ce qui a été modifié et vérifié, ainsi qu’une liste des affirmations qui n’ont pas pu être confirmées à partir de sources fiables et nécessitent une revue humaine.

Limites

• Eigent ne peut pas accéder aux données clients privées, aux éléments de feuille de route non publiés ou aux wikis internes, sauf si vous les fournissez explicitement.
• L’exactitude de la documentation dépend de la qualité des commentaires source et de la couverture des tests — les comportements non documentés peuvent être manqués.
• Les très grands sites de documentation tirent profit d’une recherche limitée à une section ou un domaine de fonctionnalités spécifique plutôt qu’à l’ensemble du site.