Una de las principales normas que se maneja actualmente en las empresas de desarrollo software es documentar proyectos, es decir, llevar un seguimiento de cada etapa por la que pase el proyecto como sustento para otros programadores o incluso por la misma persona que lo elabore.
Puede resultar curioso saber que existen empresas que no realizan estas documentaciones, a pesar de ser parte de los procedimientos, de acuerdo al proyecto se puede considerar necesario o no hacerlo.
Sin embargo lo importante es tener en cuenta el significado de documentar, no sólo como parte de un proyecto de software, sino como la acción de recopilar los datos más importantes de un tema en específico, en este caso el desarrollo de software.
Es común no documentar proyectos ¿por qué?
Los desarrolladores priorizan la realización de las tareas que les fueron asignadas y la resolución de problemas que surgen durante la programación, en vez de hacer foco en la documentación. Sin embargo, existen razones específicas por las cuales deciden no hacerlo.
- Es aburrido: El documentar en general es un proceso que a muy pocas personas les parece interesante, por el contrario a muchas personas les resulta aburrido.
- No es prioridad: Los desarrolladores suelen tener una lista de tareas para cumplir durante los proyectos, muchas de esas tareas definen tareas y pasos de otros desarrolladores, por lo que en sus prioridades está terminar tareas, empezar otras y resolver los problemas que encuentren durante el proyecto.
- Se debe actualizar constantemente: Como es común en el área tecnológica día a día actualizan las herramientas que utilizan los desarrolladores, al documentar proyectos se debe hacer de tal manera que sea sencillo de actualizar o de entender los datos viejos para actualizarlos y que sea funcional.
- Nadie lee las documentaciones: Los desarrolladores no suelen leer los archivos o guías que se les facilitan, por lo que hacerlo ellos les parece una pérdida de tiempo.
Riesgos por no documentar
Documentar proyectos es una tarea exigida por algunas empresas o incluso puede ser un requerimiento del cliente, al no hacerlo se corren riesgos que además de convertirse en problemas cuestan tiempo y dinero.
Los principales riesgos que puede tener el desarrollador al no documentar son:
- El principal riesgo de no documentar proyectos es ignorar esta actividad como una tarea y dejarlo para el último momento, donde quizá el tiempo es mejor invertirlo en correcciones de desarrollo.
- Al no documentar pueden perderse datos que resulten útiles en un futuro, si bien las tecnologías se actualizan existen datos que son estáticos y pueden ser utilizados en el futuro.
- En la documentación se tienen que agregar todos los pasos del desarrollo, si no se documentan los errores, en el futuro es posible perder tiempo intentando resolver algo que podría estar documentado.
Cómo empezar la documentación
Al entender la base del problema sabemos porque documentar proyectos es importante para una empresa de tecnología, en principio se debe tener claro cuáles son las prioridades del cliente, es decir, además del orden de cada proceso se debe documentar dónde y porqué aparece cada tarea.
Los errores son parte también de la documentación, por eso se deben agregar de tal manera que pueda ser utilizada como base de toda la información para realizar un proyecto similar.
- Documentación básica
El problema más común con el que se encuentran los programadores es que al solicitar ayuda o al realizar onboarding a algún integrante del equipo no se pueda poner en marcha el software por falta de información dentro del mismo.
Por eso es de suma importancia agregar ciertos datos a la documentación para que cualquiera que desee realizar una evaluación pueda hacerlo. Los principales datos a tener en cuenta son:
- Comandos con los que la persona pueda hacer correr el proyecto.
- Todas las posibles variables con las cuales se pueda establecer la configuración de inicio.
- Preguntas básicas y frecuentes.
2. Profundizar en el tema
Luego de haber realizado la documentación básica, se debe avanzar con la con los datos más avanzados, pensando en mediano y largo plazo, teniendo en cuenta que el límite de tiempo debería ser máximo de cuatro meses.
Un equipo de desarrollo está comprendido por varios equipos; un ejemplo son los equipos de Frontend y Backend, en este caso es importante que ambos estén al tanto del trabajo que realiza el otro. El estar sincronizados es fundamental, les permite comunicarse y estar al tanto sobre cómo se va desarrollando el software desde el principio. De esta forma pueden conocer en detalle los datos que ambos están utilizando para el desarrollo.
Para documentar en esta etapa es importante tener en cuenta que:
- Se debe especificar qué equipo fue el encargado de documentar cada parte del proyecto final, si bien hay pasos que pueden ser obvios, es importante que se especifique.
- Durante la documentación hay datos que puede realizar cualquier equipo, por eso es importante hacer contratos donde se establezca quién va a documentar cada parte del proyecto.
- Parte de ser una documentación específica está en incluir toda clase de herramientas tecnológicas que se utilizaron durante el desarrollo, desde decisiones tecnológicas, hasta frameworks.
3. Reunir la información facilitada por el cliente
Para realizar un desarrollo con documentación con bases sólidas, se debe hablar con el cliente y conseguir información que solo él puede facilitar, esta información se debe ordenar y desde allí se puede acoplar a cada paso del proyecto.
La documentación se debe realizar desde el principio y dando acceso a está información a todos los miembros del equipo, esto se puede ver en:
- Datos de credenciales para las herramientas que esté utilizando el equipo.
- Datos del cliente como servidores que ya utiliza, desde qué plataformas posee otros proyectos.
- Material que garantice la seguridad tanto para el cliente, como para el desarrollo del proyecto.
- Elementos visuales que contribuyan al trabajo del equipo de Frontend, asimismo test de integración que complemente al Backend.
3 Razones por que las que se debe documentar proyectos
Para los desarrolladores la documentación de proyectos de software no es la principal de sus prioridades, sin embargo es una herramienta que puede ser de gran ayuda para el equipo
- Todos los integrantes del equipo trabajan bajo los mismos protocolos
Al documentarlos procesos se consigue que cada uno de los integrantes del equipo trabajen de la misma manera. Se puede conseguir que todos los desarrolladores utilicen las mismas herramientas, sabrán en qué momento acudir al jefe del equipo o al cliente porque todos tienen una misma línea de trabajo.
Se especifican las tareas a realizar por parte de cada equipo y a su vez por cada integrante del equipó, pero lo más importante es que cada uno trabajara con la política que se tenga dentro de la empresa, con los lineamientos empresariales y cubriendo todas las necesidades especificadas por el cliente.
- Los procesos de ingreso de nuevos integrantes son más sencillos
Al ingresar una nueva persona al proyecto es mucho más sencillo que se integre al equipo si se tiene la documentación correcta; es decir, a la persona solo se le debe facilitar el material necesario para que cumpla con las tareas que se le asignó.
De está manera se ahorra tiempo para el resto del equipo, es más sencillo que la persona nueva se adapte el proyecto y no es necesario que alguien lo esté supervisando, esto además facilita que las tareas y tiempos de gestión empiecen a ser cubiertos mucho más rápido.
- Ayuda a medir el rendimiento de los integrantes del equipo
Al implementar un mismo desarrollo de software varias veces se puede llegar a identificar distintos indicadores que ayuden a determinar y evaluar el rendimiento del proyecto, de sus integrantes de equipo y la rentabilidad de un departamento.
¿Documentar proyectos es beneficioso?
Documentar proyectos es una actividad que trae beneficios importantes para el desarrollo de un software, son beneficios no solo para la empresa, sino también para el cliente.
- Poseer un manual que ayudará a futuros proyectos.
- Evaluación de la rentabilidad del proyecto.
- Se puede realizar un seguimiento para su mejora.
- La gestión al finalizar el proyecto es más sencilla.
A pesar de ser una actividad que puede resultar aburrida para los desarrolladores es conveniente si se ve desde el lugar de la gestión de toda la información que deben poseer los integrantes del equipo de desarrollo.
En cuanto a los beneficios para los clientes en la documentación de proyectos ayuda a preservar la información necesaria para resolver problemas menores de la gestión del software, es decir, el cliente cuenta con datos para resolver el mismo esta clase de problemas.
Sin duda documentar proyectos es una práctica que deber ser aplicada por todas las empresas de tecnología al desarrollar un software, ya que trae beneficios y facilidades para todos los involucrados en el desarrollo.
El hábito de documentar los proyectos es uno de los pilares fundamentales del equipo Streambe, ya que nos aseguramos de la funcionalidad del desarrollo en cada uno de sus procesos, de está manera consolidar los mejores resultados a nuestros clientes.
Si te gustó esta nota, compartila.