Escribir documentacion de código con Inteligencia Artificial

¿Alguna vez has tenido dificultades para entender el código de un compañero de trabajo? Siendo un área esencial en cualquier equipo de desarrollo, desde frontend, backend hasta equipos de Data Science.

La documentación de código puede ser un reto, pero también una ciudad desbloqueada gracias a la intersección de la inteligencia artificial y las herramientas de documentación. Vamos a explorar cómo el uso de inteligencia artificial puede facilitar enormemente el proceso de documentación de código.

¿Cómo puede la Inteligencia Artificial mejorar la documentación del código?

La documentación del código es vital para que cualquier persona pueda entender un proceso, continuar con él, y mejorar la estructura de la documentación y del código en una organización. Afortunadamente, existen diversas herramientas de inteligencia artificial diseñadas para hacer este proceso menos tedioso.

¿Cómo puede Notion asistir en la documentación de código?

Notion, un conocido repositorio de documentación, no solo se usa para crear documentación técnica sino también para manejar información de cualquier tipo. Lo que lo hace poderoso es su motor de inteligencia artificial que ayuda a crear todo tipo de documentación, incluyendo la técnica.

Para documentar código en Notion, se puede simplemente copiar y pegar el código, luego usar la función Ask AI para darle instrucciones con lenguaje natural. Por ejemplo, si decides agregar un bloque de código SQL, puedes pedirle al AI que cree una documentación técnica como un diccionario de datos y agregue descripciones para las columnas y tablas.

¿Cómo puede ChatGPT ayudar a crear documentación?

Otra herramienta poderosa es ChatGPT, la cual puede usarse para documentar código. Para usar esta función en ChatGPT, debes darle una consigna al chatbot sobre qué tienes que documentar. Por ejemplo, puedes darle un script en Python y decirle que comente y haga una descripción sobre la función del script.

También, ChatGPT puede generar comentarios explicativos para cada sección del código y una descripción general de la función del script. Una vez creada, esta documentación puede ser fácilmente copiada y pegada en Notion o cualquier otro repositorio de documentación.

¿Pueden estas herramientas manejarse con cualquier lenguaje de programación?

Lo interesante de estas herramientas es que son muy versátiles. No solo trabajan con SQL o Python, sino con cualquier otro lenguaje de programación, incluyendo ROS, PHP, JavaScript, entre otros. Gracias a ello, son útiles para entender el código de cualquier compañero, especialmente si no estás familiarizado con el lenguaje en que está escrito.

El uso de herramientas de inteligencia artificial para inspeccionar y documentar tu código no sólo ahorra tiempo, sino que también mejora la accesibilidad y escalabilidad del código en cualquier equipo de desarrollo. Esto permite a todos los miembros entender mejor el proceso y continuar con él, mejorando la eficiencia en la organización.