Documentación y base de conocimiento

Qué abarca esta categoría

Lugares donde dejar las cosas por escrito para que otras personas puedan encontrarlas: centros de ayuda para clientes, manuales internos, documentación para desarrolladores y la búsqueda que hace útil cualquiera de ellos.

La distinción que importa es el público. La documentación para clientes necesita una dirección pública, un proceso de revisión y un lenguaje escrito para alguien que ya está atascado. La documentación para el personal puede ser más desordenada y necesita permisos en su lugar.

El conocimiento personal y de equipos pequeños pertenece a notas y wiki. La cola de tickets donde llegan las preguntas sin respuesta es atención al cliente.

La estructura decide si algo se encuentra

Todo proyecto de documentación empieza ordenado y acaba como un montón. Las herramientas lo frenan o lo aceleran.

Mire cómo funciona la jerarquía: categorías, subpáginas, enlaces cruzados y si una página puede estar en dos sitios sin duplicarse. Mire luego qué ocurre con trescientas páginas, que es donde se hunde una navegación diseñada para treinta.

La búsqueda es la prueba honesta. Pruebe una consulta con las palabras que usaría un cliente y no con su vocabulario interno. Los productos que solo coinciden con los títulos fallarán esa prueba, y los lectores acabarán en su cola de soporte.

Las etiquetas y las sugerencias de artículos relacionados ayudan cuando se mantienen. Nadie las mantiene a mano durante mucho tiempo, así que prefiera productos que generen las conexiones a partir del contenido.

Escribir, revisar y mantener las páginas veraces

La documentación se pudre en silencio. Una página que era correcta en marzo es un ticket de soporte en septiembre, y nada en ella parece errado.

Los productos útiles incluyen responsables, fechas de revisión y un sello de última comprobación que el lector puede ver. Los estados de borrador y el flujo de revisión importan cuando escriben más de dos personas, y el historial de versiones importa la primera vez que alguien pregunta qué decía una página antes de cambiar.

También conviene comprobar la reutilización. Un límite, un precio o una lista de versiones compatibles deberían existir una sola vez e incluirse en todos los sitios donde aparecen, en lugar de pegarse en once páginas que discreparán el próximo trimestre.

Publicación y la cuestión de la búsqueda

Un centro de ayuda público es un sitio web y debería comportarse como tal.

• URL limpias que sobrevivan a una reorganización, con redirecciones cuando no puedan.
• Títulos y descripciones editables por artículo, no generados a partir de la primera línea.
• Páginas rápidas, sin una aplicación pesada que se cargue antes de que aparezca el texto.
• Mapas del sitio que se actualicen al publicar y no según un calendario que nadie recuerda.
• Un dominio propio, para que el material genere autoridad para su sitio y no para el del proveedor.

Este último punto merece defenderse internamente. La documentación suele ser el mejor contenido que tiene una empresa de software, y alojarla en un subdominio del proveedor regala ese tráfico.

Medición y la única métrica que importa

Las páginas vistas no dicen casi nada. Dos cifras dicen mucho.

La primera son las búsquedas que no devolvieron ningún resultado útil, que es una lista escrita de lo que hay que crear a continuación. La segunda es si los lectores que abrieron un artículo contactaron después con soporte, lo que exige conectar el centro de ayuda con su sistema de tickets.

Reescriba a partir de esa lista y no de la opinión. Los cinco artículos que fallan con más frecuencia merecen más atención que cincuenta que nadie visita.

Cómo se cobran estos productos

Puestos para los autores, a veces lectura gratuita para todos y a veces por lector interno registrado. Los centros de ayuda públicos suelen cobrar por autor y por volumen de artículos, y las wikis internas por usuario.

Vigile tres límites. Los dominios propios, las versiones y el inicio de sesión único suelen estar un nivel por encima del plan de entrada. La profundidad de la analítica es un cuarto. Los proveedores que combinan un centro de ayuda con un producto de soporte suelen cobrarlo como complemento en lugar de incluirlo, una de las costumbres reunidas en lo que ocultan las páginas de precios.

Antes de comprometerse, exporte todo y lea el resultado. Markdown o un marcado limpio significan que puede irse. Un formato propietario significa que el archivo es rehén.

Montar un centro de ayuda desde cero

La primera versión debería ser vergonzosamente pequeña.

Tome las veinte preguntas que más recibe su cola de soporte y respóndalas bien. Eso cubre la mayoría de los contactos y lleva una semana, mientras que planificar primero una estructura completa lleva un trimestre y no responde nada mientras tanto.

Escriba cada artículo para alguien que ya está atascado, es decir, la respuesta primero y la explicación después. Las capturas envejecen mal, así que úselas donde ayuden de verdad y cuente con reemplazarlas.

Deje que la estructura emerja. Tras treinta artículos las categorías se vuelven evidentes, e imponerlas en el quinto significa reorganizar de todos modos.

Publique los términos de búsqueda que no devolvieron nada como su cola de redacción. Es el único plan de contenidos de esta categoría que nunca se agota y nunca se equivoca.