fbpx

¿Cómo documentar un proyecto?

¿Cómo documentar un proyecto?

La documentación de un proyecto se refiere al respaldo de la información en un soporte específico. Su objetivo es dejar un registro de las decisiones y avances para transparentar los procesos.

Documentar nunca es una pérdida de tiempo.

¿Por qué documentar?

El ser humano es el único animal capaz de tropezar dos veces con la misma piedra.

Básicamente para no caer dos veces sobre el mismo error y personas futuras que puedan entrar en la compañía no se encuentren con esos problemas. No se trata de hacerle una foto al proceso o al producto y enmarcarla. La documentación tiene una utilidad palpable, es una tarea dinámica que busca la mejora continua de la empresa. Nos permite conocerla y comprenderla mejor, establecer objetivos y orientar al personal hacia la consecución de estos.

¿Cómo documentar?

Ahí la gran pregunta que todos los proyectos se enfrentan (a menos que tengan personas con conocimientos de setup de documentación)

Escribe documentación que sea atractiva y clara

La regla más importante de una buena documentación es que sea lo más atractiva posible. Esto significa que debemos intentar escribirlo en los términos más claros posibles sin omitir ningún paso. Debemos evitar hacer suposiciones sobre lo que nuestros compañeros pueden saber. A veces esto puede parecer exagerado, y podemos estar tentados a decir algo como “todo desarrollador de X sabe de Y”, pero cada uno de nosotros aportamos nuestros propios antecedentes y experiencias a un proyecto.

Documenta de la siguiente manera.

información  completa

información detallando todos los aspectos del proyecto.

La documentación debe ser exhaustiva. Esto significa que todos los aspectos del proyecto están documentados. La documentación completa de todas las características elimina este tipo de ambigüedad.

Escribir documentación que pueda ser ojeada de forma rápida

Cuando escribimos documentación que es skimmable (ojeable rápidamente), ayudamos a los usuarios a encontrar el contenido que necesitan rápidamente.

Ofrecer ejemplos siempre es una buena idea

Escribir documentación que tenga repetición, cuando sea útil

Es perfectamente aceptable incluir alguna repetición en la documentación. Al hacerlo, se reconoce que los usuarios no pueden leer los documentos completos o que alguna información es relevante en varios lugares de la documentación.

Actualiza la documentación

La documentación efectiva se mantiene actualizada. Esto es sorprendentemente desafiante. Podemos comenzar nuestro proyecto con las mejores intenciones y una gran documentación, pero a medida que nuestro proyecto evoluciona y nos estamos poniendo en marcha rápidamente, puede ser fácil caer fuera de ritmo. ¿Cómo podemos conseguir esto? Dedicando tiempo a ello. Al finalizar el sprint hay que documentar lo trabajado.

Cuatro ojos ven más que dos

En la medida de lo posible (a menos que haya una persona en el equipo que se dedica íntegramente a documentar) es mejor que la documentación pase por una revisión de algún colega de trabajo. Recordemos que no haces la documentación para ti, sino para el resto de compañeros. Un doble-check evita ambigüedades.

No olvides las herramientas para documentar, al alcance de todos.

Hay multitud de herramientas con la que podemos documentar y no hay ninguna peor o mejor, eso lo decidirá el equipo. Aquel que se ajuste a las necesidades de trabajo que tengamos y nuestro stack. No obstante tenemos que mirar a largo plazo. ¿Es escalable?.

Algunas de estas herramientas son:

  • Box
  • Confluence
  • Notion
  • WordPress
Abrir chat
Hola, ¿Necesitas ayuda?
Hola,
Bienvenido a Ticher Institute, ¿en qué podemos ayudarte?