Codex use case
Gardez la documentation à jour
Automatisez les mises à jour de la documentation à partir du code et d’autres sources.
Avec Codex, comparez les modifications du code source avec la documentation publique, les notes de version et le contexte fourni par les pull requests. Rédigez ensuite des mises à jour ciblées de la documentation et précisez les vérifications à effectuer avant publication.
Best for
- Documentation pour les développeurs, fichiers README, guides d’exploitation, exemples et notes de migration à tenir à jour lorsque le comportement du produit change fréquemment.
- Équipes qui tiennent à jour la documentation d’un produit technique.
Contents
Gardez la documentation à jour
Automatisez les mises à jour de la documentation à partir du code et d’autres sources.
Avec Codex, comparez les modifications du code source avec la documentation publique, les notes de version et le contexte fourni par les pull requests. Rédigez ensuite des mises à jour ciblées de la documentation et précisez les vérifications à effectuer avant publication.
Avec Codex, comparez les modifications du code source avec la documentation publique, les notes de version et le contexte fourni par les pull requests. Rédigez ensuite des mises à jour ciblées de la documentation et précisez les vérifications à effectuer avant publication.
Related links
Best for
- Documentation pour les développeurs, fichiers README, guides d’exploitation, exemples et notes de migration à tenir à jour lorsque le comportement du produit change fréquemment.
- Équipes qui tiennent à jour la documentation d’un produit technique.
Skills & Plugins
- Si vous utilisez GitHub pour recueillir les signalements de bugs, consultez les tickets, les pull requests, les commentaires, les fils de discussion des revues de code et les résultats des vérifications qui ont échoué.
| Skill | Why use it |
|---|---|
| GitHub | Si vous utilisez GitHub pour recueillir les signalements de bugs, consultez les tickets, les pull requests, les commentaires, les fils de discussion des revues de code et les résultats des vérifications qui ont échoué. |
Starter prompt
Introduction
Il est plus facile de tenir la documentation à jour si vous la modifiez en même temps que le code source, sans attendre plusieurs semaines. Codex peut examiner le code modifié, les tests, les notes de version, les tickets associés et le contexte des pull requests, puis rédiger une mise à jour ciblée qui respecte la structure de la documentation.
Utilisez ce workflow pour rédiger de la documentation destinée aux développeurs, mettre à jour un fichier README, préparer un journal des modifications ou rédiger des notes de migration, des procédures d’exploitation ou tout autre document qui décrit un comportement susceptible de changer fréquemment.
Marche à suivre
-
Partez du changement à documenter.
Indiquez la branche, la pull request, le commit, le ticket ou les fichiers concernés. Si la documentation est publique, précisez qu’elle doit exclure les éléments de la feuille de route qui n’ont pas encore été publiés, les renseignements privés sur les clients et les informations réservées à un usage interne.
-
Demandez à Codex de repérer les passages concernés dans la documentation.
Avant qu’il commence à rédiger, demandez-lui de rechercher dans la documentation existante les noms des fonctionnalités, les clés de configuration, les commandes, les exemples et les termes associés.
-
Limitez la mise à jour aux passages nécessaires.
Codex doit conserver la structure de la page, la terminologie, les liens entre les pages et les métadonnées d’en-tête. Il doit éviter de réécrire des pans entiers de la documentation lorsqu’il suffit d’ajouter une précision ou un exemple, ou de mettre à jour une section.
-
Vérifiez les modifications.
Demandez à Codex d’exécuter les contrôles de mise en forme et de documentation adaptés au dépôt, puis de résumer les éléments qui étayent chaque affirmation destinée aux utilisateurs.
Éléments à fournir à Codex
| Source | Utilité |
|---|---|
| Code et tests modifiés | Codex peut analyser le comportement réel pour rédiger des mises à jour ciblées. |
| Notes de version publiques ou documentation publique du produit | Codex peut reprendre la terminologie publique et décrire les fonctionnalités conformément aux informations publiées sur leur disponibilité et leur statut. |
| Contexte de la pull request ou du ticket | Codex peut comprendre la raison du changement et déterminer quel comportement compte pour les utilisateurs. |
| Contrôles de la documentation exécutés localement | Codex dispose de critères précis pour déterminer si la documentation est prête à être publiée. |
Des sources complémentaires, comme les notes de version publiques, aident Codex à éviter d’inclure des informations privées ou des changements qui n’ont pas encore été annoncés publiquement.
Réutilisation du workflow
Pour définir des règles communes à tout le dépôt, consignez vos exigences en matière de documentation dans AGENTS.md. Voici un exemple.
## Documentation
- Lorsqu’un comportement visible par les utilisateurs change, vérifiez s’il faut mettre à jour la documentation, les exemples ou les journaux des modifications.
- Dans la documentation publique, ne présentez que des informations publiques ou des comportements observables dans ce dépôt.
- Conservez la terminologie et les métadonnées d’en-tête existantes.
- Avant de transmettre la version finale de la documentation, exécutez les contrôles de mise en forme et de compilation.Si le processus comporte davantage d’étapes, faites-en un skill pour que Codex puisse suivre les mêmes étapes lors de futures tâches : vérifier les sources, rédiger la documentation et contrôler le résultat. Pour en savoir plus sur cette méthode, consultez Enregistrer des workflows sous forme de skills.
Vous pouvez aussi planifier une tâche pour ce workflow depuis la discussion en cours. Par exemple, demandez à Codex de récupérer les pull requests GitHub récentes et de mettre à jour la documentation chaque semaine.
Related use cases
Créer des jeux par navigateur
Décrivez votre jeu à Codex pour qu’il en tire un plan précis, puis développe une version...
Créer une CLI que Codex peut utiliser
Demandez à Codex de créer une CLI qu’il pourra exécuter depuis n’importe quel dossier...
Enquêtez sur un incident et testez un correctif
Fournissez à Codex Cloud un dossier d’incident expurgé des données sensibles et un...