Búsqueda con IA en la documentación
Quienes leen documentación suelen saber qué quieren hacer, pero no cómo se llama la página que lo explica. La búsqueda en documentación con IA acepta la tarea con las palabras del lector y devuelve una respuesta basada en la documentación indexada.
Debe complementar una navegación clara y la búsqueda exacta, no esconder la documentación.
Empieza por las tareas, no por el número de páginas
Recopila preguntas de tickets de soporte, del buscador del sitio, del onboarding y de los comentarios de desarrolladores. Asocia cada pregunta a la página que debería responderla.
Algunos ejemplos:
- "¿Dónde autorizo mi dominio?"
- "¿Cómo actualizo las páginas capturadas?"
- "¿Qué formatos de archivo puedo subir?"
- "¿Por qué no aparece el asistente en mi web?"
Si una pregunta requiere información repartida en varias páginas, decide si conviene unificar la documentación o si una respuesta combinada con fuentes resulta realmente útil.
Captura el perímetro de la documentación
Configura el trabajo de captura de datos web con el nombre de host de la documentación y la ruta relevante. Excluye versiones antiguas, índices generados, páginas de cuenta y material interno.
Revisa los enlaces descubiertos y el contenido del dataset antes de conectar la experiencia para los visitantes.
Elige la interfaz adecuada
Un centro de búsqueda funciona bien cuando buscar es la tarea principal en la documentación y merece su propia URL pública. Un asistente integrado funciona cuando los lectores deben poder preguntar sin salir de la guía en la que están.
En ambos casos, muestra enlaces a las fuentes para que los lectores puedan revisar requisitos previos, código, advertencias y el contexto.
Prueba la utilidad de las respuestas
| Prueba | Condición para aprobar |
|---|---|
| Formulación como tarea | La terminología del lector recupera la guía correcta |
| Configuración exacta | Los valores y las etiquetas de la interfaz coinciden con la fuente |
| Procedimiento de varios pasos | La respuesta mantiene el orden documentado |
| Pregunta sobre versiones | Se usa la versión actual |
| Integración no soportada | La respuesta no inventa compatibilidad |
| Cita | El enlace abre la página que contiene el dato indicado |
Mantén disponible la búsqueda exacta por palabras clave para identificadores, códigos de error, métodos de API y títulos de página conocidos. Las respuestas directas y la búsqueda convencional resuelven tareas distintas en la documentación.
Revisa las conversaciones para detectar páginas que faltan y terminología confusa; después mejora la documentación y vuelve a capturarla.