La importancia de documentar las cosas

• Tweet
• Share
• Email
• Sharebar

• Tweet
• Share
• Email

Muchas empresas nuevas e innovadoras, así como empresas en plena fase de crecimiento (sobre todo en el sector on line y de tecnologías) se desenvuelven muy rápidos, trabajando en varios proyectos al mismo tiempo para entrar en nuevos mercados y aprovechar nuevas oportunidades. Todos los recursos se concentran en estos proyectos, ya que al final de todo será lo que pagará las cuentas. La tarea de documentar las ideas, ponerlos por escrito para la posteridad muchas veces se olvida entre tanta euforia (y estrés) de lo nuevo. Se lo deja para otro, o para el mañana que nunca llega.

“No hemos decidido todavía que formato que tendrá este proyecto, así que no queremos documentarlo ahora para no tener que rehacerlo después.”

“Bueno, no hay documentación, porque hemos estado haciendo esto la vida entera, así que todo mundo sabe como funciona.”

“No tenemos tiempo para eso. Estamos siempre mejorando el sistema, así que documentarlo no tiene mucho sentido para nosotros.”

Esto son mis razones favoritos por las cuales no se elabora la documentación. Sin embargo, hay unos argumentos muy importantes para dedicar tiempo y esfuerzo para documentar la base de los hechos lo más conciso posible. No se trata de hacer un plan lo más detallado posible. Se trata de elaborar una documentación básica, que sirve a todos los departamentos y que asegura que todo el mundo esté hablando de la misma cosa y con los mismos argumentos.

• El equipo de marketing y ventas sabrá exactamente cuales características del producto/servicio ya están implementados y cuales todavía se encuentran en fase de desarrollo. Eso les ayudará en el trato con (posibles) clientes.
• Cuando las personas claves del departamento de desarrollo quieren ausentarse por el nacimiento de la hija, el resto del equipo sabrá como reconstruir todo lo que ya se ha hecho sin tener que llamar a la nueva madre cada dos por tres.
• Todos los departamentos en la cadena de valor entienden lo que aportan al servicio/producto y así podrán usar correctamente sus herramientas y aportar ideas para mejorarlos.
• Nuevos miembros de la organización pueden utilizar la documentación para aprender más rápido su trabajo y sin tener que interrumpir demasiadas veces a sus compañeros.

Para poner en práctica todas estas ventajas la empresa no necesita una documentación de lo más detallada con todos los algoritmos utilizados y las especificaciones técnicas y estratégicas anexados. Lo que hace falta es dedicar los recursos necesarios para elaborar una documentación base que se revisará a cada 4 semanas (si es un proyecto en andamiento) o cada 6 meses (si se esperan solo pequeñas mejoras). Actualizar la documentación, adicionando nuevas características y usos es mucho más fácil una vez que existe una primera versión autorizada.

Pero cuales son las características claves para una documentación base que le sirve a toda la empresa?

• Utiliza un lenguaje claro y simple. La documentación base tiene que servir de ayuda a todos en la empresa, sin distinción de procedencia departamental, conocimiento técnico, lugar de trabajo. Todo el mundo debe entender lo que aporta este producto/módulo/proceso/servicio.
• Describe los resultados, no las especificaciones técnicas. A diferencia con la documentación técnica, la documentación base pone hincapié en lo que hace/debe hacer el producto o proceso en cuestión. Por ejemplo: “la herramienta de google para generar palabras claves ofrece una selección de búsquedas populares de los usuarios. La información se extrae del buscador google y se agrega dentro de la herramienta. De este modo los interesados se pueden informar sobre la popularidad de las palabras de búsqueda.” No hace falta adicionar el algoritmo exacto usado por google, ni donde, domo y cuando se agregan las palabras de búsqueda. La idea general es suficiente para que todo el mundo entienda de que se trata.
• Explica los detalles que tienen una influencia especial sobre el uso de producto. Por ejemplo en la herramienta de google obtienes diferentes resultados al buscar por documentación o por documentaciones. Esta diferencia es importante, así que hay que mencionarla en la documentación base. Al contrario, google no se importa si escribes con mayúsculas o minúsculas. Por lo tanto no es importante realzar este tema.

No todo el mundo le gusta documentar procesos y productos. Y a algunos se les va más fácil que a otros. Trata de encontrar alguien en la empresa que conoce el proceso en total pero que también se ha fijado en los detalles, y que además tiene el don de escribir con clareza y simplicidad. Esta persona deberá hablar con los desarrolladores, con los departamentos que utilizan los procesos y productos, y también con ventas y marketing para entender lo que más les importa. De esta manera podrá incorporar los puntos más importantes para todos los departamentos.

Finalmente, la documentación deberá ser evaluada por una persona por deaprtamento para a) encontrar posibles fallos en la explicación y b) encontrar donde todavía faltan detalles (lo que solo se nota una vez puesto por escrito).

La versión final se distribuirá a todos los implicados en el proceso o producto y se guardará en un lugar de fácil acceso. Como solo explica las características claves del producto, pero sin especificar como se llega a estos características, no habrá secretos comerciales en riesgo, sin embargo la calidad del trabajo dentro de los departamentos incrementará una vez que todos entiendan que parte tienen en la cadena de valor.

Y claro: hay que asegurarse que todos lean la documentación!