featured image

Hace tiempo, en reuniones mantenidas por todo el departamento técnico, sobre todo la parte de I+D, de la empresa en la que trabajo, mi compañero Juan Sebastián me comentó: podemos hacer la documentación en un blog.

Después de haber empleado métodos tradicionales como MS Word, OpenOffice Writer, LaTeX, DocBook... y otros más dinámicos como el wiki, aquella idea sonaba extraña, pero con cierto sentido.

Tras revisar el proyecto Knowledge Tree (árbol de conocimiento), llegué a ver más claro lo que comentaba mi compañero y comencé a verlo mucho más útil que toda la pila de documentación general que se realiza normalmente.

Los problemas

Cuando se realiza documentación, generalmente, se realiza un documento con una serie de apartados bien definidos y completados de la forma más completa posible.

El primer problema viene cuando hay que escribir el documento, el soporte. ¿Se hace en Internet a través de una página tipo wiki para que todo el mundo colabore?, ¿se hace en un sistema tipo foro para que se establezca en plan discusión?, ¿se hace en un sistema de control de incidencias para documentar tarea a tarea lo que llegue?

Este planteamiento deriva en otros muchos problemas. Cada uno, tiene el problema individual de que, cuando el nivel de información crece, la forma de buscar entre sus tripas para encontrar lo que se busca se hace más complejo y tedioso. Este sería el segundo problema de estos sistemas.

En el caso de que se haga una documentación formal. Tienes la posibilidad de imprimirlo cada vez que se haga una revisión del documento y dejarlo encuadernado y visible para uso de cada persona de la empresa o en un directorio compartido al que puedan tener acceso. Volvemos al principal problema de la búsqueda de la información dentro del documento, así como, cuando las personas vean que el documento excede de 20 páginas, seguramente lo mirarán con miedo.

El tercer y mayor problema... ¿quién lo mantiene?, en el caso de un documento wiki, hay que ir revisando sus páginas, al igual que en el documento formal escrito en formato de libro y es un trabajo que, una vez que el documento se extiende más allá de las primeras 20 páginas, se hace cada vez más dificultoso.

¿Y el blog lo soluciona todo?

Bueno, no es una panacea. Eso hay que tenerlo claro. Como comenté antes, el sistema Knowledge Tree tiene de bueno que comparte similitudes con los blogs, pero tiene la carencia de que los documentos escritos, siguen siendo los convencionales de procesador de textos, o cualquier editor que genere un PDF.

Por sus características, un blog tiene las siguientes ventajas:

  • Los blogs tienen artículos. Pueden constituir recetas en las que poner datos necesarios que se vean importantes para proporcionar información al resto de la empresa.
  • Un blog tiene categorías donde se agrupan todos los artículos escritos. En este caso, las categorías podrían delimitar áreas técnicas como: web, sistema, explotación, infraestructura, atención al cliente, administración, dirección...
  • Cada artículo puede contener una o varias etiquetas (tags). Estas etiquetas pueden ser esenciales para localizar documentos que tengan que ver con temas tan diversos como: altas de clientes, facturación, despliegue, desarrollo, entorno de trabajo...
  • Los artículos se escriben rápidamente y desde cualquier sitio, pueden contener media (imágenes, vídeos, presentaciones, audios...), que puede ayudar mucho a la documentación en sí.
  • Los artículos tienen la posibilidad de agregar comentarios. Esto es muy útil porque se pueden agregar actualizaciones pequeñas por otras personas, o preguntas frecuentes que no se hayan recogido en el propio artículo.
  • Los pingbacks o trackbacks, son referencias que hace un artículo contra otro cuando es referido por él. Esto es muy útil cuando queremos tener relaciones entre artículos, que quedan almacenadas en los mismos, a través de enlaces. E incluso actualizaciones a través de nuevos artículos.

Por todo ello, un buen sistema de blog puede ser empleado como sistema de gestión documental fácil de llevar a producción y fácil de implementar entre los trabajadores, sobre todo en el entorno de programadores, administradores de sistemas y similares.