No tienes acceso a esta clase

隆Contin煤a aprendiendo! 脷nete y comienza a potenciar tu carrera

Escribir documentacion de c贸digo con Inteligencia Artificial

9/10
Recursos

驴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.

Aportes 16

Preguntas 1

Ordenar por:

驴Quieres ver m谩s aportes, preguntas y respuestas de la comunidad?

o inicia sesi贸n.

Yo us茅 Chat GPT para crear el readme de una API que cre茅.
Les comparto Hajime no Ippo API

Cuantas empresas no les ayudar铆a esto, como dijo el profe

Estas herramientas, definitivamente, ayudar谩n demasiado a los desarrolladores a escribir documentaci贸n, sin morir en el intento.

Hace 6 meses cre茅 con ChatGPT los README de algunos de mis proyectos en github y ac谩 est谩n los resultados, en ese entonces se empezaba a hablar de esto.
https://github.com/xhapa/Queens-Alive
https://github.com/xhapa/Tower-of-Hanoi

es facil usar las herramientas de inteligencia artificial pero ay que saber pedir los codigos

Notion es un software de gesti贸n de proyectos y para tomar notas. Est谩 dise帽ado para ayudar a los miembros de una empresa u organizaci贸n a coordinar plazos, objetivos y tareas en 谩reas de la eficiencia y la productividad.

Estas herramientas funcionan con cualquier lenguaje y tienen un contexto amplio, incluyendo bibliotecas y c贸digo para facilitar una buena documentaci贸n. No solo las podemos utilizar para documentar nuestro propio c贸digo, sino tambi茅n para comprender el c贸digo de otras personas.
La documentaci贸n es una tarea que muchas organizaciones descuidan, ya que a menudo los desarrolladores no disponen del tiempo necesario ni siempre siguen las mejores pr谩cticas para llevar a cabo una documentaci贸n oficial.
Nuestro prompt en ChatGPT, para documentar nuestro codigo es: Eres experto en \[inserte aqu铆 lenuaje de programaci贸n] y en buenas practicas de documentaci贸n de c贸digo. Te dara un script en \[lenguaje] y tienes que comentarlo y hacer una descripci贸n de la funci贸n del script. Utiliza documentaci贸n tecnica de alto nivel.
Existen otras herramientas como * Bard * Bing Chat * ChatGPT
Notion IA comienza a redactar en formato Markdown. Lo sorprendente es que tiene un entendimiento a nivel t茅cnico de cu谩l es el prop贸sito del modelo. En muchas ocasiones, crea una descripci贸n incluso cuando esta no est谩 en el c贸digo, y muchas de estas descripciones son acertadas, aunque en otros casos es necesario precisar un poco m谩s.
Magico
Existen herramientas de IA que pueden ayudarte a documentar tu c贸digo y hacer que este proceso sea menos tedioso, como Notion AI. Notion cuenta con un motor interno de IA que facilita la creaci贸n de diversos tipos de documentaci贸n t茅cnica.
La documentaci贸n siempre es fundamental en el desarrollo de software. > En mi trabajo anterior, ten铆a la creencia de que si no est谩 documentado, no est谩 completo. Es importante saber c贸mo documentar el c贸digo donde sea que se est茅 ejecutando, as铆 como en repositorios de documentaci贸n oficial, como Notion y GitHub. De esta manera, cualquiera que lo consulte podr谩 comprender tu proceso, continuar con 茅l y realizar mejoras."

Documentaci贸n en software es algo muy importante, lamentablemente algunos 鈥渄evelopers鈥 no valoran su importancia.

Anotado Notion AI para a帽adir a mi toolbox 馃摑