arrow_back Volver
Inicio keyboard_arrow_right Artículos keyboard_arrow_right Artículo

Cómo crear la documentación para tu proyecto.

Mary Fernández

av_timer 2 Min. de lectura

remove_red_eye 518 visitas

calendar_today 17 Noviembre 2022

Últimamente he estado en constante contacto con estudiantes que recién comienzan en el mundo de la programación y he notado que una de las mayores dudas se presentan al momento de crear la documentación de su proyecto.

En este post voy a darte algunos consejos para lograr una documentación exitosa. Usaré de ejemplo una que hice para mi proyecto final del Bootcamp Frontend.

Pero antes que nada:

📄 ¿Qué es la documentación?

La documentación es un archivo preferentemente en PDF que será como la carta de presentación a tu proyecto, donde las personas podrán saber un poco más sobre las etapas del desarrollo.

Las partes fundamentales de una buena documentación son:

  • Título del proyecto.
  • Nombre del o de las personas que trabajaron en él.
  • Acceso al proyecto: Puedes agregar tu repositorio o el live demo.

Informacíon

  • Descripción: Cuenta un poco de qué trata tu proyecto,su función, concepto y/o objetivos. En esta parte puedes utilizar capturas de pantalla para ser más específico.
  • Retos y dificultades: Puedes comentar cuáles fueron los desafíos que tuviste que enfrentar a la hora de realizar este proyecto.

Retos enfrentados

  • Cómo fueron resueltos estos retos.
  • Tus logros: Partes del proyecto que sientas orgullo de haber logrado, incluso puedes adjuntar bloques del código.
  • Estado del proyecto: Especifica si seguirás trabajando o ya está finalizado.

Logros

Para hacerlo más llamativo, en lo personal me gusta que el diseño de mi proyecto se vea reflejado en su documentación, asi que uso la misma paleta de colores e imágenes acordes.

Puedes utilizar Canva, una website gratis en la cual puedes crear piezas asombrosas de contenido visual. Con ella vas a poder agregarle fotos, colores, videos e incluso gifs a tu documento. ¡Deja volar tu imaginación! 🙂

En este caso mi proyecto era una página web de cafetería con gatitos en adopción, así que utilice imágenes que hagan referencia al tema.

Espero que este post haya resuelto las dudas a la hora de realizar la documentación de tu proyecto.

¡Éxitos en tu aprendizaje! 🚀