For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navigation principale

Suggestions
API Dashboard
Essayer ChatGPT
Codex

Codex use case

Maintenir la documentation à jour

Utilisez le code source et d’autres sources pour automatiser les mises à jour de la documentation.

Difficulty Facile
Time horizon 30 min

Utilisez Codex pour comparer les modifications du code source, la documentation publique, les notes de version et le contexte de la PR, puis rédiger des mises à jour ciblées de la documentation, accompagnées d’étapes de vérification avant leur publication.

Idéal pour

  • Documentation pour les développeurs, fichiers README, guides d’exploitation, exemples et notes de migration qui doivent rester à jour à mesure que les comportements évoluent.
  • Équipes responsables de la documentation d’un produit technique.

Contents

    ← Tous les cas d’utilisation

    Maintenir la documentation à jour

    Utilisez le code source et d’autres sources pour automatiser les mises à jour de la documentation.

    Utilisez Codex pour comparer les modifications du code source, la documentation publique, les notes de version et le contexte de la PR, puis rédiger des mises à jour ciblées de la documentation, accompagnées d’étapes de vérification avant leur publication.

    Facile
    30 min

    Utilisez Codex pour comparer les modifications du code source, la documentation publique, les notes de version et le contexte de la PR, puis rédiger des mises à jour ciblées de la documentation, accompagnées d’étapes de vérification avant leur publication.

    Facile
    30 min

    Liens connexes

    Flux de travail

    Idéal pour

    • Documentation pour les développeurs, fichiers README, guides d’exploitation, exemples et notes de migration qui doivent rester à jour à mesure que les comportements évoluent.
    • Équipes responsables de la documentation d’un produit technique.

    Skills et plugins

    • GitHub
      Examinez les issues, les pull requests, les commentaires, les fils de discussion de revue et les vérifications ayant échoué lorsque GitHub fait partie de votre processus de triage des bugs.
    Skill Why use it
    GitHub Examinez les issues, les pull requests, les commentaires, les fils de discussion de revue et les vérifications ayant échoué lorsque GitHub fait partie de votre processus de triage des bugs.

    Prompt de démarrage

    Mettez à jour la documentation de [product/feature] à partir des sources suivantes : - les fichiers source modifiés dans [this repo/source linked repo] - les pages de documentation existantes qui mentionnent un nouveau comportement - toute issue, PR ou note de version associée, ainsi que toute référence publique que je fournis ci-dessous Puis : - identifiez ce qui est visible par les utilisateurs - mettez à jour uniquement les pages de documentation qui doivent être modifiées - excluez de la documentation publique toute feuille de route non publiée, toute information privée concernant les clients et tout contexte réservé à un usage interne - préservez la structure, la terminologie et les liens croisés existants de la documentation - exécutez les vérifications de la documentation adaptées à la modification Avant de finaliser, résumez les modifications apportées, les vérifications effectuées et les affirmations que vous n’avez pas pu confirmer à partir de sources fiables. [link release notes or other references here]
    Mettez à jour la documentation de [product/feature] à partir des sources suivantes : - les fichiers source modifiés dans [this repo/source linked repo] - les pages de documentation existantes qui mentionnent un nouveau comportement - toute issue, PR ou note de version associée, ainsi que toute référence publique que je fournis ci-dessous Puis : - identifiez ce qui est visible par les utilisateurs - mettez à jour uniquement les pages de documentation qui doivent être modifiées - excluez de la documentation publique toute feuille de route non publiée, toute information privée concernant les clients et tout contexte réservé à un usage interne - préservez la structure, la terminologie et les liens croisés existants de la documentation - exécutez les vérifications de la documentation adaptées à la modification Avant de finaliser, résumez les modifications apportées, les vérifications effectuées et les affirmations que vous n’avez pas pu confirmer à partir de sources fiables. [link release notes or other references here]

    Introduction

    Il est plus facile de maintenir la documentation à jour en la modifiant en même temps que le code source, plutôt que plusieurs semaines plus tard. Codex peut examiner le code et les tests modifiés, les notes de version, les issues associées et le contexte des pull requests, puis rédiger une mise à jour ciblée de la documentation qui en respecte la structure existante.

    Utilisez ce flux de travail pour la documentation destinée aux développeurs, les mises à jour de fichiers README, les brouillons du journal des modifications, les notes de migration, les guides d’exploitation ou tout autre contenu qui doit rester à jour à mesure que les comportements évoluent.

    Comment l’utiliser

    1. Commencez par la modification à documenter.

      Partagez la branche, la pull request, le commit, l’issue ou les fichiers concernés. Si la documentation est publique, précisez explicitement que la feuille de route non publiée, les informations privées sur les clients et le contexte réservé à un usage interne ne doivent pas y figurer.

    2. Demandez à Codex de recenser les pages de documentation concernées.

      Avant la rédaction, demandez-lui de rechercher dans la documentation existante les noms de fonctionnalités, les clés de configuration, les commandes, les exemples et les termes connexes.

    3. Limitez les modifications de la documentation au strict nécessaire.

      Codex doit préserver la structure actuelle de la page, la terminologie, les liens croisés et le frontmatter. Il doit éviter de réécrire de larges portions lorsqu’une note ciblée, un exemple ou la mise à jour d’une section suffit.

    4. Vérifiez les modifications.

      Demandez à Codex d’exécuter les vérifications de mise en forme et de documentation adaptées au dépôt, puis de résumer les éléments qui étayent chaque affirmation concernant le comportement visible par les utilisateurs.

    Ce qu’il faut fournir à Codex

    SourcePourquoi c’est utile
    Code et tests modifiésPermet à Codex d’analyser le comportement réel pour rédiger des mises à jour ciblées de la documentation.
    Notes de version publiques ou documentation du produitAide Codex à refléter fidèlement la terminologie publique, la disponibilité et le statut de la fonctionnalité.
    Contexte de la pull request ou de l’issueExplique pourquoi la modification a été apportée et quel comportement visible par les utilisateurs doit être pris en compte.
    Vérifications locales de la documentationFournit à Codex des critères concrets pour déterminer si le travail est terminé avant de publier la documentation.

    Fournir davantage de contexte, par exemple des notes de version publiques, aide Codex à éviter d’inclure des informations privées ou des mises à jour qui ne sont pas encore publiques.

    Rendez le flux de travail reproductible

    Pour établir une convention à l’échelle du dépôt, ajoutez les exigences relatives à la documentation dans AGENTS.md. Par exemple :

    ## Documentation

- When user-facing behavior changes, check whether docs, examples, or changelogs need updates.
- Public docs must only include public information or behavior visible in this repo.
- Preserve existing terminology and frontmatter.
- Run the docs formatting and build checks before final handoff.

    Si le processus comporte davantage d’étapes, transformez-le en skill afin que les tâches Codex à venir puissent suivre le même cycle d’examen des sources, de rédaction et de vérification. Pour en savoir plus sur cette approche, consultez Enregistrer des flux de travail sous forme de Skills.

    Vous pouvez aussi planifier une tâche pour ce flux de travail depuis la discussion en cours. Par exemple, demandez à Codex de récupérer les pull requests GitHub récentes et de maintenir la documentation à jour chaque semaine :

    Planifiez une tâche pour le flux de travail ci-dessus depuis cette discussion. Récupérez toutes les PRs récentes dans [this repo/linked repo] et mettez à jour la documentation en fonction des modifications.

    Cas d’utilisation associés

    Créer une CLI utilisable par Codex

    Demandez à Codex de créer une CLI composable qu’il pourra exécuter depuis n’importe quel...

    Ingénierie Code

    Créer des jeux sur navigateur

    Avec Codex, transformez le brief d’un jeu en un plan bien défini, puis en un véritable jeu...

    Ingénierie Code

    Poursuivre un objectif

    Utilisez `/goal` lorsqu’une tâche exige que Codex poursuive son travail au fil de plusieurs...

    Ingénierie Automatisation