Documentación con Wiki.js

Que se encuentre: búsqueda y navegación

Lección 6 de 8 · 14 min

Una página que no se encuentra no existe

Puedes tener el mejor procedimiento del mundo escrito. Si quien lo necesita no lo encuentra en dos intentos, va a preguntarle a alguien - y tu documentación no sirvió para nada.

Encontrar es la mitad del trabajo, y depende sobre todo de cómo escribes.

Escribe con las palabras que usa quien busca

Este es el hábito que más cambia las cosas. La gente busca con sus palabras, no con las tuyas ni con las oficiales de la empresa.

La misma página, encontrable o no
TITULO OFICIAL, no se encuentra:
  Procedimiento de solicitud de ausencia remunerada

COMO LO BUSCA LA GENTE:
  vacaciones
  pedir dias
  permiso

SOLUCION - el titulo natural, y las otras palabras dentro:
  Titulo:  Como pedir vacaciones
  Primera linea:  Para solicitar vacaciones, dias libres o un permiso
                  remunerado (formalmente, "ausencia remunerada")...
Resultado
Asi la pagina responde a las cuatro busquedas, sin renunciar
al termino oficial.

Incluye los sinónimos y los nombres viejos. Si el sistema antes se llamaba de otra forma, menciónalo: la gente que lleva años ahí lo va a buscar por el nombre antiguo. Una línea del tipo «antes conocido como…» resuelve años de búsquedas fallidas.

Cómo funciona la búsqueda

Wiki.js indexa el contenido de las páginas para poder buscar dentro de ellas, no solo en los títulos. Hay varios motores de búsqueda configurables, desde el sencillo que viene por defecto hasta otros más potentes.

Para una wiki de decenas o cientos de páginas, el que viene por defecto sobra. La calidad de los resultados depende mucho más de cómo escribes que del motor que elijas.

Cuatro costumbres que hacen encontrable una wiki

Ninguna es técnica:

  1. Títulos que digan qué responden

    «Cómo pedir vacaciones», no «Política de ausencias». El título es lo que más pesa en cualquier búsqueda y lo primero que se lee en los resultados.

  2. Una primera línea que resuma

    Lo que aparece bajo el título en los resultados. Si dice «Esta página describe el procedimiento…», no aporta nada. Que diga qué se resuelve y para quién.

  3. Enlaza entre páginas

    Cuando menciones algo que está explicado en otra página, enlázalo. Mucha gente no llega buscando: llega navegando desde una página cercana.

  4. Usa las etiquetas con cabeza

    Wiki.js permite etiquetar páginas. Sirven si son pocas y consistentes: cinco etiquetas usadas por todos valen más que cuarenta que cada uno inventa.

La página de inicio es un mapa, no una bienvenida

La portada de la wiki no debería decir «Bienvenido a nuestra base de conocimiento». Eso no ayuda a nadie.

Debería ser un mapa: enlaces a las secciones principales y, sobre todo, a las cinco o seis páginas que más se consultan. Muchas búsquedas se resuelven ahí sin buscar nada.

Lo que sí funciona en la portada

«Empezar aquí» para quien llega nuevo, las secciones principales con una línea de qué hay en cada una, y una lista de «lo más consultado».

Revisa qué busca la gente y no encuentra

Si tu wiki registra las búsquedas, míralas de vez en cuando. Las búsquedas sin resultado son una lista gratis de lo que falta por documentar, escrita por la propia gente que lo necesita.

Pregunta a quien acaba de entrar

Quien lleva dos semanas en el equipo es la mejor fuente: todavía recuerda lo que no encontró. A los seis meses ya se sabe dónde está todo y deja de ver el problema.

Compruébalo tú mismo

Tu empresa llama "ausencia remunerada" a lo que todos conocen como vacaciones. ¿Cómo titulas la página?

Siguiente: Mantenerla viva: el problema que mata las wikis

Continuar ← Permisos: quién ve qué y quién puede editar