# Pruebas de documentacin de API con simulacin de usuarios AI > [! nota]- > El contenido de esta página se ha generado a partir de la transcripción de audio/vídeo y la transformación del texto del contenido y los enlaces de esta fuente. Fuente: [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> ## Resumen y aspectos destacados: **Introducción** La sesión aborda cómo la simulación de usuarios impulsada por AI puede mejorar la documentación de API en proyectos de código abierto. Lisa Driukova, una escritora técnica de JetBrains, presenta un concepto que utiliza AI para identificar vacíos y inconsistencias en la documentación de API, lo que ayuda a mejorar la calidad y adopción de proyectos de código abierto. **Desafíos en la Documentación de API** La documentación de API enfrenta desafíos debido a la multitarea de los contribuyentes en proyectos de código abierto. La falta de tiempo y la experiencia desigual entre los usuarios y los desarrolladores complican la recolección de comentarios útiles, lo que afecta la calidad de la documentación. **Solución Propuesta** Driukova propone usar simulaciones de usuarios con AI para probar la documentación desde múltiples perspectivas. Esta técnica permite identificar casos límite y preguntas sin respuesta, reduciendo la carga cognitiva sobre los escritores y mejorando la claridad y usabilidad de la documentación. **Implementación y Personalización** El flujo de trabajo incluye especificaciones OpenAPI, generación de preguntas y la identificación de vacíos. La técnica es personalizable, permitiendo usar diferentes escenarios y personas de usuario para adaptarse a las necesidades específicas de un proyecto. **Conclusión y Llamado a la Acción** La calidad de la documentación es crucial para la adopción exitosa de proyectos de código abierto. La simulación de usuarios con AI no reemplaza a los humanos, sino que potencia sus esfuerzos. Se invita a la comunidad a experimentar con este enfoque y compartir sus hallazgos para mejorar la técnica. ## Importancia para una transformación ecosocial Esta técnica tiene un gran potencial para la transformación ecosocial al mejorar la documentación de proyectos de código abierto, lo que facilita su adopción y uso. La colaboración comunitaria es esencial para refinar esta técnica, y su implementación puede llevar a un software más accesible y sostenible. Los diseñadores ecosociales pueden aplicar esta técnica para garantizar que la documentación de sus proyectos sea inclusiva y accesible. Sin embargo, existen desafíos técnicos, como la necesidad de suficiente contexto para que el AI funcione correctamente, y sociales, como fomentar la participación de la comunidad para proporcionar retroalimentación valiosa. ## Slides: | | | | --- | --- | | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_001.jpg\|300]] | Lisa Driukova presenta cómo la simulación de usuarios con AI puede identificar vacíos en la documentación de API, mejorando así la calidad y usabilidad de los proyectos de código abierto. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_002.jpg\|300]] | El uso actual de AI en la documentación de API incluye búsqueda mejorada, fragmentos de código inteligentes, chatbots, resúmenes de documentación y registros de cambios automáticos. Sin embargo, los humanos deben proporcionar la información necesaria al AI. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_003.jpg\|300]] | Las barreras para recibir retroalimentación incluyen limitaciones de tiempo y diferencias en la experiencia. Los usuarios experimentados pueden pasar por alto detalles que los principiantes consideran importantes, y esto se multiplica en entornos de código abierto. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_004.jpg\|300]] | La simulación de usuarios con AI permite probar la documentación desde múltiples perspectivas, identificando casos límite y preguntas sin respuesta sin depender exclusivamente de revisores humanos, reduciendo así la carga cognitiva sobre los escritores. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_005.jpg\|300]] | El flujo de trabajo incluye la especificación OpenAPI, extracción de información, generación de preguntas, identificación de vacíos y salida de una lista de preguntas. Se invita a probar esta técnica. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_006.jpg\|300]] | El prompt se estructura para que AI actúe como un desarrollador que usa la documentación de API para implementar e integrar, generando preguntas prácticas y no filosóficas, y enfocándose en aspectos como el manejo de errores y casos límite. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_007.jpg\|300]] | En la API de Petstore, se identificaron vacíos como la posibilidad de eliminar entidades inexistentes, manejar mascotas duplicadas y la reutilización de IDs, además de la falta de códigos y mensajes de error. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_008.jpg\|300]] | La técnica es personalizable con diferentes personas de usuario y escenarios de prueba, permitiendo elegir el modelo de lenguaje adecuado para mejorar la identificación de vacíos en la documentación. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_009.jpg\|300]] | La calidad de la documentación es crucial para la adopción y usabilidad. La simulación de usuarios con AI es útil para probar la documentación. Este POC es un punto de partida para mejorar y personalizar la técnica. | ![[FOSDEM 2025/assets/API-documentation-testing-with-AI-user-simulation/preview_010.jpg\|300]] | Lisa Driukova agradece a la audiencia e invita a conectarse con ella a través de su sitio web y LinkedIn. ## Enlaces [Slides](https://fosdem.org/2025/events/attachments/fosdem-2025-4912-api-documentation-testing-with-ai-user-simulation/slides/238001/FOSDEM_20_0iBbYsZ.pdf) [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)