Améliorer la documentation avec l'IA à l'aide de Rig & Rust

Introduction

Récemment, j'ai été chargé de chercher à améliorer la documentation produit dans laquelle je travaille. Ce n'est pas une tâche énorme en soi, mais souvent, lorsque vous êtes dans une startup, vous avez souvent beaucoup de choses à jongler et différentes choses à prioriser. Même si nous pourrions simplement parcourir chaque page de documentation au hasard et vérifier, cela prendrait énormément de temps. De plus, à mesure que la documentation augmente en raison des fonctionnalités du produit, nous devons nous assurer que la qualité des documents est la plus élevée possible.

Dans cet article, nous allons créer un petit outil rudimentaire capable de télécharger un dépôt GitHub de notre choix, de l'analyser pour les fichiers de démarque, puis d'envoyer chaque fichier via un pipeline qui utilisera OpenAI pour classer chaque page de documentation ainsi que générer unrésultats.jsonfichier qui contiendra une liste de suggestions pour améliorer toutes les pages de documentation éligibles (supposées être des fichiers markdown).

Nous classerons nos pages de documentation à l'aide du framework Diataxis, ce qui signifie que chaque page sera l'une des suivantes :

• Comment faire
• Tutoriel
• Explication
• Référence

Une fois classés, nous demanderons ensuite à notre LLM de choix comment nous pouvons améliorer chaque page de documentation.

Si vous souhaitez simplement essayer le projet, visitez ce dépôt GitHub puis passez directement à la section Utilisation de cet article.

Construire notre outil d'amélioration de la documentation

Commencer

Avant de commencer, vous devez vous assurer que le langage de programmation Rust est installé. Vous devrez également vous assurer que vous disposez d’une clé API OpenAI.

Analyse des référentiels GitHub

Pour interagir avec les référentiels GitHub, nous pouvons exploiter leoctocrabecaisse. L'objectif est de télécharger un référentiel, d'extraire son contenu e...
[Courte citation de 8% de l'article original]