Documentación con Wiki.js

La estructura: que la información se encuentre

Lección 3 de 8 · 16 min

La decisión que determina si la usan

Una wiki bien escrita y mal organizada no se usa. Si encontrar algo cuesta más que preguntarle a alguien, la gente pregunta - y con eso vuelves al problema de la lección 1.

La estructura no es un detalle estético: es lo que decide si la wiki sirve.

⚠️ El error más común: copiar el organigrama. Carpetas llamadas «Contabilidad», «Ventas», «Sistemas». Parece lógico y no funciona, porque obliga a saber quién hace algo para encontrar cómo se hace.

Alguien que busca cómo pedir vacaciones no sabe si eso lo lleva Talento Humano, Administración o su jefe. Y si el equipo se reorganiza, tu estructura entera queda obsoleta.

Organiza por tarea, no por departamento

La gente no busca «Contabilidad»: busca «cómo hago una factura». Nombra las secciones por lo que alguien va a querer hacer.

La misma información, dos estructuras
POR DEPARTAMENTO - hay que saber quien lo hace
  /contabilidad
  /ventas
  /sistemas
  /talento-humano

POR TAREA - se busca lo que se quiere hacer
  /empezar-aqui          para quien llega nuevo
  /clientes              cotizar, facturar, cobrar
  /equipos-y-sistemas    accesos, computadores, claves
  /personas              vacaciones, permisos, contratacion
  /proveedores           compras, pagos
Resultado
La segunda sobrevive a una reorganizacion del equipo.
La primera hay que rehacerla cada vez que cambian los cargos.

Tres niveles como máximo

Sección, subsección, página. Y ya. Si necesitas un cuarto nivel, casi siempre significa que la sección de arriba mezcla dos cosas distintas y hay que partirla.

Cada nivel de más es un clic más y una decisión más para quien busca. A partir del tercero, la gente se rinde y pregunta.

Nivel 1: la sección

Un área de actividad. Entre cinco y ocho en total.

/clientes

Nivel 2: la subsección

Un tema dentro de esa área.

/clientes/facturacion

Nivel 3: la página

Un procedimiento concreto, uno solo.

/clientes/facturacion/emitir-una-factura

Una página, un tema

La regla más útil y la que más se incumple. Si una página explica cómo emitir una factura y además cómo anularla y además qué hacer si el cliente reclama, son tres páginas.

Por qué importa

Porque la gente busca una cosa concreta. Si al buscar «anular factura» aterriza en una página de tres mil palabras donde eso es el tercer apartado, tiene que leerse el resto para encontrarlo.

Cómo saber si hay que partirla

Si el título necesita una «y», son dos páginas. «Emitir y anular facturas» son dos cosas.

Y si están relacionadas, se enlazan

Al final de «emitir una factura», un enlace a «anular una factura». Los enlaces entre páginas son lo que convierte páginas sueltas en una wiki.

Los nombres de las páginas

Se nombran por lo que responden, en las palabras que usaría quien busca. No en las palabras internas de tu empresa:

Nombres que se encuentran
MAL                              BIEN
Procedimiento PR-014             Como emitir una factura
Gestion de accesos               Pedir acceso a un sistema
Onboarding                       Que hacer en tu primer dia
Politica de RRHH nº3             Como pedir vacaciones
Resultado
Nadie busca "PR-014". Todo el mundo busca "factura".
El codigo interno puede ir DENTRO de la pagina, no en el titulo.

La página que nunca falta: «Empezar aquí». La primera que ve alguien nuevo, con enlaces a las cinco cosas que necesita el primer día. Es la página más visitada de cualquier wiki que funcione, y la que casi nadie crea.

Empieza pequeño

No diseñes la estructura completa antes de escribir nada. Es el camino seguro a tener veinte secciones vacías.

Crea las tres o cuatro secciones que necesitas hoy, escribe páginas de verdad, y crea secciones nuevas cuando tengas contenido que no encaje. La estructura debe crecer detrás del contenido, no delante.

Compruébalo tú mismo

¿Por qué no conviene organizar la wiki por departamentos?

Vas a escribir una página titulada "Emitir y anular facturas". ¿Qué conviene hacer?

Siguiente: Escribir: Markdown y los editores

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