# Tester la documentation API avec une simulation utilisateur AI > [! remarque]- > Le contenu de cette page est généré à partir de la transcription audio/vidéo et de la transformation du texte provenant du contenu et des liens de cette source. Source : [https://fosdem.org/2025/schedule/event/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation/](https://fosdem.org/2025/schedule/event/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation/) <video src=« https://video.fosdem.org/2025/k4201/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation.av1.webm » controls></video> ## Résumé et points forts : Cette session explore l'utilisation de l'IA pour améliorer la documentation API grâce à des simulations d'utilisateurs. **Introduction à l'importance de la documentation API**: Lisa Driukova, une rédactrice technique chez JetBrains, explique que la documentation API de haute qualité est essentielle pour l'adoption des projets open source. Cependant, le retour d'information et la révision de la documentation sont souvent négligés en raison des contraintes de temps et des écarts d'expertise. **Utilisation de l'IA pour combler les lacunes**: L'IA peut simuler des interactions utilisateur pour identifier les lacunes et incohérences dans la documentation API, offrant ainsi une perspective nouvelle et réduisant le fardeau manuel. Cette méthode est particulièrement utile dans les projets open source où les contributeurs doivent jongler avec plusieurs rôles. **Processus et avantages**: Le processus comprend l'extraction des spécifications OpenAPI, la génération de questions et l'identification des lacunes. Cette approche permet de tester la documentation sous différents angles, en utilisant des scénarios spécifiques et en réduisant les biais. **Personnalisation et collaboration communautaire**: La méthode peut être adaptée avec différents rôles utilisateur et scénarios, et son succès dépend de la collaboration communautaire. Lisa invite les participants à expérimenter et à partager leurs idées pour améliorer cette approche. ## Importance pour une transformation écosociale Cette session est cruciale pour une transformation écosociale car elle propose une méthode pour améliorer la documentation des projets open source, renforçant ainsi leur adoption et leur durabilité. Les questions sociales incluent la réduction des biais et l'amélioration de l'accessibilité pour les utilisateurs de tous niveaux d'expertise. Les concepteurs écosociaux peuvent appliquer cette méthode en intégrant des simulations d'utilisateurs AI dans leurs processus de documentation, favorisant une meilleure collaboration et un retour d'information plus efficace. Les défis incluent la nécessité de garantir des données contextuelles adéquates pour l'IA et de surmonter les contraintes de temps et d'expertise dans les équipes. ## Slides: | | | | --- | --- | | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_001.jpg\|300]] | La première diapositive présente le concept de test de la documentation API à l'aide de simulations d'utilisateurs basées sur l'IA. Lisa Driukova, rédactrice technique senior chez JetBrains, souligne l'importance de cet outil pour améliorer la qualité de la documentation. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_002.jpg\|300]] | La deuxième diapositive décrit les cas d'utilisation actuels de l'IA dans la documentation API, tels que la recherche améliorée, les extraits de code intelligents, les chatbots et la création de journaux de modifications automatisés. Elle souligne que les humains doivent fournir des informations à l'IA. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_003.jpg\|300]] | La troisième diapositive aborde les obstacles à la rétroaction, tels que les contraintes de temps et l'expertise. Elle explique comment ces défis sont amplifiés dans l'écosystème open source, où les utilisateurs expérimentés et débutants perçoivent différemment les lacunes de la documentation. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_004.jpg\|300]] | La quatrième diapositive propose la simulation utilisateur pilotée par l'IA comme solution pour tester la documentation sous plusieurs perspectives et identifier les cas limites et les questions sans réponse, tout en réduisant la charge cognitive sur les rédacteurs et les parties prenantes. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_005.jpg\|300]] | La cinquième diapositive décrit le flux de travail pour le test de la documentation API : entrée des spécifications OpenAPI, extraction des informations, génération de questions, identification des lacunes, et sortie d'une liste de questions. Elle encourage l'expérimentation. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_006.jpg\|300]] | La sixième diapositive détaille l'anatomie du prompt utilisé dans la simulation. Elle décrit le rôle de développeur, l'objectif d'analyser les spécifications OpenAPI 3.0, et les restrictions pour se concentrer sur des questions pratiques et éviter les questions philosophiques. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_007.jpg\|300]] | La septième diapositive présente les lacunes identifiées dans l'API Swagger Petstore, telles que la gestion des entités inexistantes, les doublons, la réutilisation des identifiants et les messages d'erreur manquants, soulignant la nécessité d'améliorer la documentation. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_008.jpg\|300]] | La huitième diapositive aborde la personnalisation de la méthode, en utilisant différents personnages d'utilisateurs, des tests basés sur des scénarios et le choix du modèle de langage, pour adapter la simulation aux besoins spécifiques. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_009.jpg\|300]] | La neuvième diapositive résume les points clés : la qualité de la documentation reste essentielle pour l'adoption réussie des logiciels, l'IA peut aider mais les humains doivent diriger, et la simulation utilisateur est un outil précieux pour tester la documentation. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_010.jpg\|300]] | La dixième diapositive remercie le public et fournit les coordonnées de Lisa Driukova, y compris son site web et son profil LinkedIn. ## Liens [Slides](https://fosdem.org/2025/events/attachments/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation/slides/238001/FOSDEM_20_0iBbYsZ.pdf) [Code sample](https://fosdem.org/2025/events/attachments/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation/code-sample/) [Video recording (AV1/WebM)](https://video.fosdem.org/2025/k4201/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation.av1.webm) [Video recording (MP4)](https://video.fosdem.org/2025/k4201/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation.av1.mp4) [Chat room(web)](https://fosdem.org/2025/chat-room-web) [Chat room(app)](https://fosdem.org/2025/chat-room-app)