Blog

Nadie lee la documentación (y no es su culpa)


Toda empresa que ha intentado mantener una documentación o wiki interna ha experimentado el mismo ciclo de vida. Lanzamiento entusiasta, creación de contenido inicial, declive gradual en las contribuciones, obsolescencia progresiva, pérdida de confianza, abandono funcional. La wiki sigue existiendo. Sigue apareciendo en los resultados de búsqueda. Nadie confía en ella porque la última vez que alguien siguió las instrucciones de una página de la wiki, estas tenían tres meses de antigüedad y la tarde resultante se echó a perder.

La explicación estándar para el fracaso de las wikis es cultural: la gente es perezosa, nadie valora la documentación, es difícil lograr que los ingenieros escriban. Esta explicación es errónea y conduce a las intervenciones equivocadas (mandatos de escritura, sprints de documentación, gamificación de contribuciones) que producen un cumplimiento temporal y ningún cambio duradero.

Las wikis fallan por razones estructurales, y cada modo de fallo tiene una solución estructural.


Modo de fallo 1: Obsolescencia

La documentación queda obsoleta en el momento en que se escribe porque el sistema que describe sigue cambiando mientras la wiki permanece congelada. Cada PR fusionado, cada cambio de arquitectura, cada ajuste de proceso hace que la wiki sea un poco menos precisa. Nadie es responsable de actualizarla, e incluso si alguien lo fuera, no tendría una forma sistemática de saber qué páginas se ven afectadas por qué cambios.

La solución: Documentación que se actualiza sola a partir de la actividad en vivo. Cuando la wiki se genera a partir de PRs de GitHub, conversaciones de Slack y grabaciones de reuniones, se mantiene al día porque se deriva de las mismas fuentes que modifican los sistemas subyacentes.


Modo de fallo 2: Búsqueda deficiente

La mayoría de las herramientas de wiki buscan por palabras clave, lo que significa que encontrar algo requiere adivinar las palabras exactas que usó el autor. "Flujo de autenticación" no encuentra "arquitectura de inicio de sesión". "Guía de despliegue" no encuentra "manual de ejecución de lanzamientos". Después de dos o tres búsquedas fallidas, los usuarios concluyen que la información no existe y le preguntan a una persona en su lugar.

La solución: Búsqueda semántica que encuentra contenido por significado. Describes lo que estás buscando y el sistema encuentra resultados conceptualmente relevantes, independientemente de las palabras específicas utilizadas.


Modo de fallo 3: Organización dependiente del colaborador

Cada colaborador estructura sus páginas de manera diferente, las nombra según sus propias convenciones y las archiva donde le parece razonable en ese momento. La arquitectura de información resultante refleja los hábitos organizativos de veinte personas diferentes en lugar de las necesidades de la persona que intenta encontrar algo.

La solución: Estructura coherente generada automáticamente. Los documentos autogenerados siguen formatos estándar (descripciones generales del sistema, registros de decisiones, registros de cambios) independientemente de quién haya generado la actividad subyacente. La organización la determina el sistema en lugar de los colaboradores individuales.


Modo de fallo 4: Sobrecarga de contribución

Escribir una página de wiki es una actividad separada de realizar el trabajo que la página describe. Requiere un cambio de contexto desde el trabajo hacia la escritura, una decisión sobre qué incluir y el conocimiento de que la página deberá mantenerse indefinidamente. Esta sobrecarga siempre se desprioriza ante la presión del tiempo.

La solución: Contribución que ocurre automáticamente. Cuando la documentación se genera a partir del propio trabajo (conversaciones de Slack, descripciones de PR, discusiones de reuniones), la contribución se produce como un subproducto del trabajo en lugar de como una tarea adicional. Nadie escribe la wiki. La wiki se escribe sola.


Cómo se ve una wiki que funciona

Una wiki que la gente realmente lee y en la que confía tiene cuatro propiedades: es actual (se actualiza automáticamente), es localizable (búsqueda semántica), es coherente (formatos estandarizados) y requiere poco esfuerzo (sin necesidad de contribución manual). La mayoría de las wikis tradicionales tienen cero de estas propiedades, razón por la cual nadie las lee.

La documentación autoescrita con búsqueda semántica proporciona las cuatro. El resultado es una base de conocimiento que se gana la confianza a través de la precisión y la utilidad, en lugar de perderla por la obsolescencia y una búsqueda deficiente. La gente la lee porque funciona, no porque se lo ordenen.


Preguntas frecuentes

¿Deberíamos borrar nuestra wiki actual? Consérvala como un archivo histórico y crea la nueva wiki autoescrita en paralelo. Con el tiempo, las personas gravitarán hacia la fuente en la que confían (la actual y con capacidad de búsqueda), y la antigua wiki se convertirá en una referencia heredada en lugar de la base de conocimiento principal.

¿Qué pasa con las páginas que requieren redacción humana (guías de estilo, políticas)? Cierto contenido sí requiere autoría humana: políticas de la empresa, directrices de marca, documentos filosóficos. Estos coexisten junto con la documentación generada automáticamente. El sistema autoescrito se encarga de la documentación fáctica y operativa. Los humanos se encargan del contenido narrativo y prescriptivo.

¿Cómo logramos que el equipo confíe en la nueva wiki? La confianza se construye mediante la precisión. Si las personas buscan en la wiki cinco veces y obtienen resultados útiles y actuales las cinco veces, seguirán buscando. El problema de confianza con las wikis tradicionales es que la precisión se degrada con el tiempo. Los documentos autogenerados mantienen la precisión de forma automática, lo que mantiene la confianza.

Lecturas relacionadas: Qué es una base de conocimiento, La documentación obsoleta es peor que la falta de documentación, Por qué Confluence no funciona. Páginas relacionadas: Documentos autoescritos, Búsqueda, Encuentra cualquier cosa.

The workspace that thinks with you.

Ready when you are.

The workspace that thinks with you.

Ready when you are.

The workspace that thinks with you.

Ready when you are.