Tenemos la intención de organizar nuestra documentación utilizando una combinación de enlaces seleccionados, etiquetas y carpetas.
Nuestra estrategia general de navegación debería consistir en dar prioridad a la identificación del por qué una persona lectora está buscando documentación y, basándose en ese contexto, intentar guiarla hacia qué información específica podría estar buscando.
Empezando por la página de inicio, ofrecemos una serie de enlaces saleccionados que ayuden a guiar a les visitantes hacia la información basada en sus casos de uso específicos con el objetivo de apoyar el modo de interacción que están buscando. Esta es nuestra principal opción de navegación para lectores.
Ejemplos
Priorizar las necesidades de las personas visitantes
Estas páginas deben evitar abrumar a sus visitantes y proporcionar listas concisas de enlaces priorizados a documentación útil. Estas selecciones deben ser informadas por la investigación a través de entrevistas directas con personas, encuestas a la membresía, tickets de soporte y métricas de tráfico de las páginas de documentación. La página de inicio y los enlaces de alto nivel pueden, a su vez, enlazar con otras selecciones temáticas de enlaces seleccionados de páginas de documentación. Si la persona visitante aún no ha encontrado lo que busca en los enlaces seleccionados, estas páginas deberían guiarle hacia listas temáticas más amplias y formas adicionales de buscar documentación basadas en palabras clave.
Algunes visitantes sabrán buscar palabras claves específicas para encontrar la información que buscan. Los nombres de servicios como correo electrónico, sitio web y videoconferencia o títulos de software específicos como Wordpress, Roundcube y Jitsi. Al igual que algunas páginas de documentación pueden estar relacionadas con más de un servicio o software, éstas también pueden estar relacionadas con múltiples palabras clave. Asignar una o varias etiquetas a una página puede ayudar a les visitantes a encontrar la documentación que buscan a través de la barra de búsqueda o de las listas generadas automáticamente. Utilice etiquetas en lugar de nombres de carpetas o rutas para clasificar la documentación en función del software, los servicios o las palabras técnicas claves.
Nuestra documentación debe ser escrita siguiendo unas formas o modos específicos como sugiere el marco de diataxis, tutoriales, guías "cómo hacer", referencia técnica y explicación. Estas formas de documentación están pensadas para ser fijas, separadas y distintas, por lo que almacenar páginas de cada tipo dentro de su propia carpeta en nuestra jerarquía de rutas de documentación es algo natural. Estas carpetas no están pensadas para ser el modo principal de búsqueda o naegación de la documentación por parte de les visitantes, aunque podrían explorarse de ese modo. Lo más importante es que sirven para guiar nuestro estilo de escritura y la estructura de las páginas. Si vas a poner una página en la carpeta de "cómo hacer", debería estar escrita como una guía "cómo hacer". En la práctica, los tutoriales y las guías "cómo hacer" también deberían enlazar hacia las páginas relacionadas de referencia técnica y de explicación para delegar este trabajo a la página apropiada y dar a les visitantes la opción de explorar más detalles.
De entre estas carpetas, es probable que las páginas de la carpeta "cómo hacer" sean las más numerosas. Con el tiempo puede ser útil subdividir este contenido en subcarpetas. Históricamente, nuestro primer impulso será crear subcarpetas basadas en servicios específicos. Esto se superpone con nuestras intenciones de utilizar etiquetas, lo que puede no ser un problema en sí mismo, pero con las carpetas y las rutas nos devuelve a una cuestión de taxonomía más compleja que, en su lugar, las etiquetas nos ayudan a evitar. ¿Cómo deberíamos nombrar exactamente estas subcarpetas? Por ejemplo, /guide/email/ y /guide/web/ pueden parecer opciones obvias para las guías "cómo hacer" relacionadas con esos servicios generales o cualquier software relacionado. Sin embargo, considere las guías "cómo hacer" relacionados con el software Nextcloud... ¿deberían llamarse /guide/nextcloud/ , /guide/file-sharing/ ? Dado que la propia plataforma Nextcloud agrupa varias aplicaciones diferentes, cada una de las cuales ofrece su propio servicio como compartir archivos, calendarios, encuestas, etc, ¿cómo deberíamos gestionar esto? Entonces, mejor no lo hagas. Podemos evitar este problema por ahora eligiendo no crear subcarpetas hasta que tengamos más claro cómo queremos proceder.