Documentación interna: la que sí se usa y la que se escribe para nadie

Equipo Divergentes Media

·

·

3 minutos de lectura
Portada del artículo: Documentación interna: la que sí se usa y la que se escribe para nadie

Pregunta a cualquier empresa si tiene documentación interna y dirá que sí. Pide que te enseñen la última vez que alguien la consultó y se hace el silencio.

El patrón es siempre el mismo: hay un manual de ochenta páginas escrito hace tres años para una certificación, y el conocimiento real de cómo se hacen las cosas está en la cabeza de cuatro personas.

La diferencia entre las dos cosas

El manual describe cómo debería funcionar la empresa. La documentación útil describe cómo funciona, con los atajos, las excepciones y el nombre de la persona a la que llamar cuando falla.

La primera se escribe para un auditor. La segunda, para el compañero que va a hacer esto por primera vez el martes. Solo la segunda se usa.

Qué merece estar escrito

No todo. Un criterio que funciona: documenta lo que cumpla al menos dos de estas tres condiciones.

  • Se hace pocas veces al año, así que nadie lo recuerda bien. El cierre, la declaración anual, la renovación de un seguro.
  • Solo lo sabe hacer una persona. Si esa persona se va o se enferma, la empresa se para.
  • Si sale mal, cuesta caro. Un pago, una presentación con plazo, una restauración de copia.

Lo que se hace todos los días y lo sabe todo el mundo no necesita documento. Se aprende mirando.

Quién lo escribe

Aquí está el error clásico: se le encarga a quien lleva diez años haciéndolo. Y esa persona escribe un texto ilegible para cualquiera que no sepa ya lo que pone, porque se salta todo lo que para ella es obvio.

Funciona mucho mejor al revés: lo escribe quien lo está aprendiendo, mientras lo aprende, y lo revisa quien sabe. La persona nueva pregunta lo que no entiende porque no le da vergüenza, y el resultado es legible para la siguiente.

Es, además, la mejor tarea que se le puede dar a alguien en su primera semana, como comentamos en la lista del primer día: es real, es útil y se puede terminar.

Dónde vive

Tres requisitos, y el tercero es el que casi nadie cumple:

  • Buscable. Si hay que saber en qué carpeta está, no existe. Nextcloud con búsqueda de contenido, un wiki o BookStack sirven.
  • Editable por quien lo usa. Si hay que pedir permiso para corregir una errata, nadie corrige nada y el documento envejece.
  • Con fecha de última revisión visible. Quien abre un procedimiento necesita saber si es de este año o de 2019. Un documento sin fecha se lee con desconfianza, y con razón.

La regla que lo mantiene vivo

Una sola, y es suficiente: cuando alguien pregunte algo que está documentado, se responde con el enlace. Cuando pregunte algo que no está, se contesta y después se escribe.

Así la documentación crece por donde hace falta, que es exactamente por donde la gente pregunta, en lugar de crecer por donde alguien decidió que era importante.

Y no hace falta ninguna herramienta nueva para empezar. Si ya tienes Nextcloud —o cualquiera de las piezas de un escritorio libre— tienes dónde ponerla hoy.

Quién escribe esto

El equipo de Divergentes Media, consultora salvadoreña de software libre. Implantamos ERP, facturación electrónica y sistemas de gestión para empresas de Centroamérica, y escribimos aquí lo que aprendemos haciéndolo. Cómo evaluamos el software y qué intereses declaramos.

Seguir leyendo