Centro de búsqueda

Crea un Centro de búsqueda para tu documentación

Secciones de documentación que entran en un dataset y devuelven una respuesta a una tarea con fuentes específicas de cada versión
Secciones de documentación que entran en un dataset y devuelven una respuesta a una tarea con fuentes específicas de cada versión

Un Centro de búsqueda de documentación ofrece a los lectores un único lugar donde hacer preguntas de implementación sobre las guías seleccionadas. Constrúyelo alrededor de la documentación que mantienes, no de toda la web de la empresa.

Define el alcance de la documentación

Enumera las versiones, productos y públicos que debe cubrir la página. Excluye versiones antiguas, runbooks internos, duplicados generados, páginas de cuenta y contenido de marketing que no responda a preguntas de implementación.

Si varias versiones deben seguir siendo consultables, haz visible la versión en los títulos y en el texto de las fuentes. Si no, una respuesta correcta para una versión antigua puede parecer actual.

Captura y revisa la documentación

Configura un trabajo de captura de datos web para el dominio y las rutas de la documentación. Ajusta con criterio la profundidad de rastreo, las rutas incluidas y las exclusiones.

Ajustes de navegación del rastreador de Seekdown para controlar las rutas capturadas y la profundidad, con datos de ejemplo
Ajustes de navegación del rastreador de Seekdown para controlar las rutas capturadas y la profundidad, con datos de ejemplo

Tras el procesamiento, revisa el dataset para comprobar:

  • títulos de páginas conocidas y términos relacionados con el código;
  • URL canónicas correctas;
  • procedimientos y requisitos previos completos;
  • etiquetas de versión;
  • navegación duplicada o páginas de impresión; y
  • secciones retiradas que deberían eliminarse.

Crea el Centro de búsqueda

Selecciona el dataset de documentación durante la creación. Usa un título y una descripción que indiquen el producto y la versión que cubre.

Añade sugerencias basadas en tareas, por ejemplo:

  • “¿Cómo configuro los orígenes permitidos?”
  • “¿Qué tipos de archivo puedo subir?”
  • “¿Cómo programo una captura recurrente?”
  • “¿Qué debo revisar si el embed no aparece?”

Cada sugerencia debe corresponder a una página mantenida que contenga la respuesta.

Prueba la navegación a través de las respuestas

Un Centro de búsqueda que encuentra una respuesta en la documentación y muestra tres tarjetas de fuentes con contenido de ejemplo
Un Centro de búsqueda que encuentra una respuesta en la documentación y muestra tres tarjetas de fuentes con contenido de ejemplo

Usa una matriz que incluya nombres exactos de funciones, descripciones de problemas, preguntas específicas de una versión y solicitudes no soportadas. Verifica tanto la respuesta como el pasaje enlazado.

En las respuestas de procedimiento, confirma que los requisitos previos y el orden de los pasos se mantienen intactos. En la resolución de problemas, confirma que el resultado cita la página del síntoma real y no una página de inicio genérica de la documentación.

Mantén sincronizados los cambios de cada versión

Asigna una programación de captura que se ajuste a tu proceso de publicación de documentación. Después de cada versión, verifica un dato modificado en la fuente, en el registro del dataset y en la respuesta del Centro de búsqueda.

El Centro de búsqueda es una capa de acceso sobre la documentación. La propiedad de la documentación, el control de versiones y la calidad de las fuentes siguen siendo la base.