Documentación con Wiki.js

El conocimiento que vive en una sola cabeza

Lección 1 de 8 · 14 min

La persona que sabe cómo se hace

En todo equipo hay alguien que sabe cómo se hace eso. Cómo se cierra el mes, cómo se configura el equipo nuevo, qué se le contesta al cliente que pregunta lo de siempre, cuál es la clave de ese trámite.

Mientras esa persona esté, todo funciona. El problema aparece cuando se va de vacaciones, cambia de puesto o se va de la empresa - y entonces se descubre que nadie más sabía.

No es un problema de empresas grandes. Le pasa igual a un negocio de tres personas, a un proyecto de dos socios o a alguien que trabaja solo y no recuerda cómo resolvió algo hace ocho meses. Documentar es escribirle a tu yo del futuro, que va a haber olvidado todo esto.

Por qué no basta con «tenemos los documentos en una carpeta»

Casi todo el mundo lo ha intentado. Y casi siempre acaba igual:

Nadie sabe cuál es la versión buena

Procedimiento.docx, Procedimiento_v2.docx, Procedimiento_final.docx, Procedimiento_final_REAL.docx.

Con cuatro copias, la información deja de ser confiable: quien la consulta no sabe cuál rige, así que pregunta a la persona - y volvemos al principio.

No se puede buscar dentro

Sabes que en algún documento está explicado, pero no en cuál. Abrir doce archivos para encontrarlo cuesta más que preguntar.

No se sabe si está al día

Un documento sin fecha visible ni historial puede llevar tres años describiendo un proceso que ya cambió. Y nadie lo sabe hasta que alguien lo sigue y sale mal.

Solo lo edita quien tiene el archivo

Si alguien detecta un error, tiene que pedir el archivo, editarlo y devolverlo. Ese trámite hace que nadie corrija nada, y la documentación se degrada sola.

Qué resuelve una wiki

Una wiki no es «los documentos en internet». Es una forma distinta de guardar el conocimiento, con cuatro propiedades que las carpetas no tienen:

Una sola versión

Cada tema tiene una página, y esa página es la verdad. Si cambia el proceso, se edita ahí. No hay copias que se contradigan.

Se busca por dentro

Escribes una palabra y encuentras todas las páginas que la mencionan. Es lo que hace que la gente la use en vez de preguntar.

Guarda el historial

Se ve quién cambió qué y cuándo, y se puede volver atrás. Eso quita el miedo a editar, que es lo que hace que la gente edite.

Todos pueden mejorar

Quien detecta un error lo corrige en el momento. La documentación mejora sola en vez de degradarse sola.

Qué merece la pena escribir

Y aquí está la clave para no acabar con una wiki de doscientas páginas que nadie lee. Se documenta lo que alguien va a necesitar buscar, no todo lo que sabes.

  1. Lo que explicas más de dos veces

    Si ya lo has contado tres veces, la cuarta debería ser un enlace. Es el mejor indicador que existe de qué documentar.

  2. Lo que solo sabe una persona

    Empieza por ahí. Es el conocimiento con más riesgo y el que más cuesta recuperar si se pierde.

  3. Lo que se hace pocas veces al año

    El cierre anual, la renovación de un contrato, el trámite que toca cada diciembre. Nadie se acuerda de cómo se hizo, ni siquiera quien lo hizo.

  4. Las decisiones y su porqué

    Lo más valioso y lo que menos se escribe. No solo «se hace así», sino por qué se hace así y qué se probó antes.

    Sin eso, alguien va a «mejorar» el proceso el año que viene y va a repetir el error que ya cometisteis.

Y qué NO documentar: lo que cambia cada semana, lo que está mejor en el propio sistema, y todo lo que puedas resolver con un enlace a la documentación oficial de quien lo hizo. Una wiki llena de cosas obsoletas es peor que no tenerla: enseña a la gente a desconfiar de ella.

Compruébalo tú mismo

¿Cuál es la mejor señal de que algo merece documentarse?

Tu equipo guarda los procedimientos en documentos dentro de una carpeta compartida. ¿Cuál es el problema principal?

Siguiente: Qué es Wiki.js: requisitos, licencia y alternativas

Continuar