Discreparé ligeramente con eso. Hay diferentes alcances de contenido de ayuda que puedes crear. Si seguimos el modelo Diátaxis, son tutoriales, guías prácticas, referencias y explicaciones.
Los tutoriales probablemente tengan un lugar para ser enlazados en la propia aplicación, de modo que si entras en una página con la intención de “quiero aprender cómo funciona esto”, puedas aprenderlo, incluso si la página no es autoexplicativa. Quizás incluso un centro de tutoriales que te permita completar un curso sobre el software si lo deseas.
Las otras 3 categorías me causan algunos problemas.
Si voy a la página de configuración de categorías, podría haber 20 cosas diferentes que quiera hacer. Poner una guía práctica allí resultaría en una lista que tendría que buscar, y debido a que tengo la expectativa de que lo que busco no tendrá necesariamente un artículo dedicado, probablemente escribiré esa pregunta en Google en lugar de buscar en la lista.
Las referencias externas son una plaga con la que tengo que lidiar a diario. Tenemos un “manual de referencia” que te dirá qué hace cada control deslizante y botón, hasta:
Botón Cancelar: Cierra el cuadro de diálogo sin aplicar los cambios
Botón Aceptar: Cierra el cuadro de diálogo, aplicando los cambios
Usar esta referencia significa que tienes que desplazarte por mucha información técnica antes de llegar a tu sección, cuando lo que realmente necesitabas era una descripción emergente que reformulara una opción con algunas palabras más.
Si intento eliminar una categoría, el comportamiento actual es casi deseable. Veo el botón, generalmente atenuado pero con un signo de interrogación, y si hago clic en él, dice:
No se puede eliminar esta categoría porque tiene subcategorías.
o:
No se puede eliminar esta categoría porque tiene 25852 temas. El tema más antiguo es…
El comportamiento es bueno, sé qué está mal y cuál es mi siguiente paso: eliminar un montón de publicaciones y subcategorías. No mejoraría enlazando a la guía práctica de “eliminar una categoría” en su lugar.
Por supuesto, sigue siendo una solución temporal al problema real: ¿Por qué no me deja eliminar una categoría con publicaciones dentro? Puedo eliminar carpetas con subcarpetas y archivos en mi sistema, ¿por qué no puedo eliminar categorías con subcategorías y publicaciones? Si no tuviera estas extrañas restricciones, no habría necesidad de una guía práctica en la aplicación en primer lugar.
Y por último, las explicaciones: eso es lo que es la publicación de blog “entendiendo los niveles de confianza”. Cuando la encontré por primera vez, fue bastante confusa: “¿es una publicación de blog aleatoria de hace 6 años realmente lo mejor que tienes como documentación?” - y enlaza a un artículo de referencia que enumera todas las cosas en una tabla, lo que estaba más en línea con lo que esperaba (aunque no ordenado de la manera que esperaba). Las explicaciones no me ayudan a resolver una tarea directamente, por lo que ponerlas en un lugar donde se completaría una tarea no funciona muy bien.
Creo que, en última instancia, si bien la documentación es importante en algunos lugares (por ejemplo, al incorporar usuarios o en casos en los que el diseño falla), es realmente el diseño el que debería ser el enfoque principal. Leer o ver un video en el que alguien te explica el sitio web rara vez es la experiencia deseada.