Introducción

Cuando se crea un proyecto de desarrollo, una de las partes más importantes es la documentación. Muchas veces el código funciona correctamente, pero otra persona no sabe cómo instalarlo, ejecutarlo o entender su estructura porque el proyecto no tiene un README claro.

En este post voy a explicar cómo utilizar IA generativa para crear un README técnico paso a paso a partir de un proyecto sencillo llamado **TaskManager**, una aplicación web hecha con HTML, CSS y JavaScript que permite añadir, completar y eliminar tareas.

El objetivo no es que la IA haga todo el trabajo sin revisar, sino utilizarla como una herramienta de apoyo para ordenar ideas, mejorar explicaciones y crear una documentación más clara.

Problema que se quiere resolver

El problema principal es que muchos proyectos técnicos no tienen una documentación suficiente. Esto puede provocar que otros usuarios o desarrolladores no entiendan:

– Qué hace el proyecto.
– Qué tecnologías utiliza.
– Cómo se instala.
– Cómo se ejecuta.
– Qué archivos son importantes.
– Qué mejoras se podrían añadir en el futuro.

Para solucionar esto, vamos a generar un README técnico con ayuda de IA generativa, revisando siempre el contenido antes de usarlo.

Puntos importantes

Antes de empezar, es importante tener claro que la IA generativa puede ayudar mucho, pero también puede equivocarse. Por eso debemos darle contexto suficiente y revisar el resultado.

Los puntos más importantes son:

– Explicar bien el proyecto.
– Usar un prompt claro.
– Revisar la respuesta generada.
– No aceptar información inventada.
– Adaptar el texto final con palabras propias.

Herramientas utilizadas

Para este ejemplo se han utilizado las siguientes herramientas:

– Visual Studio Code.
– HTML.
– CSS.
– JavaScript.
– Navegador web.
– Una herramienta de IA generativa.
– GitHub para guardar el proyecto.

Paso 1: Crear el proyecto base

Primero se crea una carpeta llamada **TaskManager-IA-README**.

Dentro de esa carpeta se crean los siguientes archivos:

TaskManager-IA-README/
├── index.html
├── style.css
├── script.js
└── README.md

El proyecto consiste en una aplicación sencilla de tareas. El usuario puede escribir una tarea, añadirla a una lista, marcarla como completada y eliminarla.

Paso 2: Crear la estructura HTML

Paso 3: Añadir estilos con CSS

Paso 4: Añadir la lógica con JavaScript

Paso 5: Preparar el prompt para la IA generativa

Una vez creado el proyecto, se prepara un prompt para pedir ayuda a la IA.

El prompt utilizado es: Actúa como un desarrollador web y ayúdame a crear un README técnico para una aplicación llamada TaskManager. Es una aplicación sencilla hecha con HTML, CSS y JavaScript que permite añadir, completar y eliminar tareas. Quiero que el README sea claro, útil para principiantes y tenga secciones de descripción, tecnologías, instalación, uso, estructura de archivos y mejoras futuras. 

Este prompt funciona bien porque incluye:

– El nombre del proyecto.- Las tecnologías utilizadas.- Qué hace la aplicación.- Qué secciones debe tener el README.- El tipo de público al que va dirigido

Paso 6: Revisar el resultado generado

Después de recibir la respuesta de la IA, no debemos copiarla directamente sin revisar. Hay que comprobar que todo lo que dice sea cierto. Por ejemplo, si la IA dice que el proyecto usa React, una base de datos o autenticación, habría que corregirlo, porque este proyecto solo utiliza HTML, CSS y JavaScript.

También se puede pedir una mejora con otro prompt: Mejora este README para que sea más claro, más profesional y fácil de entender para una persona que está empezando en desarrollo web. No inventes funcionalidades que no existan en el proyecto.

Paso 7: Crear el README final

El README final debe incluir secciones como:

– Descripción del proyecto.- Objetivo.- Tecnologías utilizadas.- Estructura de archivos.- Cómo ejecutar el proyecto.- Funcionamiento.- Problemas encontrados.- Mejoras futuras.- Autor.

Esto permite que cualquier persona que entre al repositorio pueda entender el proyecto de forma rápida.

Problemas encontrados

Uno de los problemas principales es que la IA puede generar contenido demasiado genérico. También puede añadir tecnologías o funcionalidades que no existen.
Para evitarlo, es recomendable escribir prompts concretos y revisar siempre el resultado final.
Otro problema es que a veces la documentación puede quedar demasiado larga. En ese caso, se puede pedir a la IA que la haga más clara y resumida, pero sin eliminar los pasos importantes.

Recomendaciones

Mis recomendaciones al usar IA generativa para crear documentación técnica son:
– Dar siempre contexto suficiente.- Explicar qué hace realmente el proyecto.- Pedir una estructura clara.- Revisar todo el contenido.- No copiar y pegar sin entender.- Adaptar el resultado con palabras propias.- No incluir funcionalidades que el proyecto no tenga.

Posibles mejoras

Este mismo proyecto se podría mejorar añadiendo nuevas funcionalidades, como guardar las tareas en el navegador con LocalStorage, añadir filtros de tareas completadas y pendientes, o mejorar el diseño responsive.
También se podría comparar un README creado manualmente con uno generado con ayuda de IA para analizar ventajas y desventajas.

Conclusion

La IA generativa puede ser una herramienta muy útil para crear documentación técnica, siempre que se utilice correctamente. En este ejemplo hemos visto cómo partir de una aplicación sencilla y generar un README claro, ordenado y útil.
La clave está en no usar la IA para sustituir el trabajo propio, sino como apoyo para organizar ideas, mejorar explicaciones y ahorrar tiempo en tareas repetitivas.

Autor/a: Julian Calvo Vicario

Máster: Desarrollo Full Stack + Arquitecturas Cloud

Centro: Tajamar Tech

Año académico: 2025-2026 Enlace a GitHub: https://github.com/JulianCalvo4/TaskManager-IA-README.git

Enlace del video: video_final_readme_ia_julian.mp4