From 4c830802897450d02d4659a7741525e733c3906d Mon Sep 17 00:00:00 2001 From: "locadex-agent[bot]" <217277504+locadex-agent[bot]@users.noreply.github.com> Date: Thu, 9 Oct 2025 23:36:46 +0000 Subject: [PATCH] docs(locadex): update translations --- docs.json | 23 ++- es/guides/accessibility.mdx | 398 ++++++++++++++++++++++++++++++++++++ fr/guides/accessibility.mdx | 398 ++++++++++++++++++++++++++++++++++++ zh/guides/accessibility.mdx | 398 ++++++++++++++++++++++++++++++++++++ 4 files changed, 1216 insertions(+), 1 deletion(-) create mode 100644 es/guides/accessibility.mdx create mode 100644 fr/guides/accessibility.mdx create mode 100644 zh/guides/accessibility.mdx diff --git a/docs.json b/docs.json index 50007456d..a792517e2 100644 --- a/docs.json +++ b/docs.json @@ -547,6 +547,13 @@ "fr/guides/migrating-from-mdx" ] }, + { + "group": "Bonnes pratiques", + "icon": "trophy", + "pages": [ + "fr/guides/accessibility" + ] + }, { "group": "Git", "icon": "git-merge", @@ -845,6 +852,13 @@ "es/guides/migrating-from-mdx" ] }, + { + "group": "Mejores prácticas", + "icon": "trophy", + "pages": [ + "es/guides/accessibility" + ] + }, { "group": "Git", "icon": "git-merge", @@ -854,7 +868,7 @@ ] }, { - "group": "Información detallada", + "group": "Ideas", "icon": "chart-line", "pages": [ "es/guides/improving-docs" @@ -1143,6 +1157,13 @@ "zh/guides/migrating-from-mdx" ] }, + { + "group": "最佳实践", + "icon": "trophy", + "pages": [ + "zh/guides/accessibility" + ] + }, { "group": "Git", "icon": "git-merge", diff --git a/es/guides/accessibility.mdx b/es/guides/accessibility.mdx new file mode 100644 index 000000000..0fce19aa3 --- /dev/null +++ b/es/guides/accessibility.mdx @@ -0,0 +1,398 @@ +--- +title: "Accesibilidad" +description: "Crea documentación que pueda usar la mayor cantidad de personas posible" +--- + +Cuando creas documentación accesible, priorizas un diseño de contenido que hace que tu documentación sea utilizable por la mayor cantidad de personas posible, sin importar cómo accedan o interactúen con ella. + +La documentación accesible mejora la experiencia de usuario para todos. Tu contenido es más claro, está mejor estructurado y es más fácil de navegar. + +Esta guía ofrece algunas prácticas recomendadas para crear documentación accesible, pero no es exhaustiva. Debes considerar la accesibilidad como un proceso continuo. Las tecnologías y los estándares cambian con el tiempo, lo que abre nuevas oportunidades para mejorar la documentación. + +
+ ## ¿Qué es la accesibilidad? +
+ +La accesibilidad (a veces abreviada como a11y por el número de letras entre la primera y la última de “accessibility”) consiste en diseñar y crear intencionalmente sitios web y herramientas que puedan utilizar el mayor número posible de personas. Las personas con discapacidades temporales o permanentes deben tener el mismo nivel de acceso a las tecnologías digitales. Y diseñar con la accesibilidad en mente beneficia a todos, incluidas las personas que acceden a tu sitio web desde dispositivos móviles o redes lentas. + +La documentación accesible sigue los estándares de accesibilidad web, principalmente las [Pautas de Accesibilidad para el Contenido Web (WCAG)](https://www.w3.org/WAI/WCAG22/quickref/). Estas pautas ayudan a garantizar que tu contenido sea perceptible, operable, comprensible y sólido. + +
+ ## Introducción a la accesibilidad +
+ +Hacer que tu documentación sea accesible es un proceso. No tienes que solucionarlo todo de una vez ni puedes hacerlo solo una vez. + +Si recién empiezas a implementar prácticas de accesibilidad en tu documentación, considera un enfoque por fases: comienza con cambios de alto impacto y avanza a partir de allí. + +
+ ### Primeros pasos +
+ +Estas son tres acciones que puedes realizar ahora mismo para mejorar la accesibilidad de tu documentación: + +1. **Ejecuta `mint a11y`** para identificar problemas de accesibilidad en tu contenido. +2. **Añade texto alternativo** a todas las imágenes. +3. **Revisa la jerarquía de encabezados** para asegurarte de que haya un H1 por página y que los encabezados sigan un orden secuencial. + +
+ ### Planifica tu trabajo de accesibilidad +
+ +El mejor flujo de trabajo es el que mejor se adapta a tu equipo. Aquí tienes una forma de abordar el trabajo de accesibilidad: + +**Fase 1: Imágenes y estructura** + +- Revisa todas las imágenes para asegurarte de que tengan texto alternativo descriptivo. +- Revisa el texto de los enlaces y reemplaza frases genéricas como “haz clic aquí”. +- Corrige problemas en la jerarquía de encabezados en toda tu documentación. + +**Fase 2: Navegación y medios** + +- Prueba la navegación con el teclado en tu documentación. +- Prueba la compatibilidad con lectores de pantalla. +- Agrega subtítulos y transcripciones a los videos incrustados. +- Revisa el contraste de color. + +**Fase 3: Incorpóralo a tu flujo de trabajo** + +- Ejecuta `mint a11y` antes de publicar contenido nuevo. +- Incluye comprobaciones de accesibilidad en tu proceso de revisión de contenido. +- Prueba la navegación con el teclado al agregar funciones interactivas. +- Verifica que los nuevos enlaces externos y los contenidos incrustados incluyan títulos y descripciones adecuados. + +Empezar poco a poco e integrar la accesibilidad en tu flujo de trabajo habitual la hace sostenible. Cada mejora ayuda a que más personas accedan a tu documentación con éxito. + +
+ ## Estructura tu contenido +
+ +El contenido bien estructurado es más fácil de navegar y comprender, especialmente para las personas que usan lectores de pantalla y dependen de los encabezados para desplazarse por las páginas, así como para quienes navegan con el teclado. + +
+ ### Usa una jerarquía adecuada de encabezados +
+ +Cada página debe tener un solo encabezado H1, definido por la propiedad `title:` en el frontmatter de la página. Usa los demás encabezados en orden, sin saltarte niveles. Por ejemplo, no pases de H2 a H4. + +```mdx + +# Título de página (H1) + +## Sección principal (H2) + +### Subsección (H3) + +### Otra subsección (H3) + +## Otra sección principal (H2) + + +# Título de página (H1) + +## Sección principal (H2) + +#### Subsección (H4) + +### Otra subsección (H3) +``` + +Los encabezados del mismo nivel deben tener nombres únicos. + +```mdx + +## Consejos de accesibilidad (H2) + +### Escribir texto alternativo efectivo (H3) + +### Usar contraste de color adecuado (H3) + + +## Consejos de accesibilidad (H2) + +### Sugerencia (H3) + +### Sugerencia (H3) +``` + + + + +El texto del enlace debe ser significativo y estar relacionado con el destino. Evita frases vagas como "haz clic aquí" o "leer más". + +```mdx + +Aprende cómo [configurar tu navegación](/organize/navigation). + + +[Más información](/organize/navigation). +``` + + +
+ ### Mantén el contenido fácil de recorrer +
+ +- Divide los párrafos largos. +- Usa listas para pasos y opciones. +- Destaca la información con avisos. + +
+ ### Usa una estructura de tabla adecuada +
+ +Usa las tablas con moderación y solo para datos tabulares cuyo significado provenga de los encabezados de columnas y filas. + +Cuando uses tablas, incluye encabezados para que los lectores de pantalla puedan asociar los datos con la columna correcta: + +```mdx +| Función | Estado | +| ------- | ------ | +| Búsqueda | Activa | +| Analytics | Activa | +``` + + +
+ ## Escribe texto alternativo descriptivo +
+ +El texto alternativo hace que las imágenes sean accesibles para las personas que usan lectores de pantalla y aparece cuando las imágenes no se cargan. Las imágenes en tu documentación deben incluir texto alternativo que describa la imagen y deje claro por qué está incluida. Incluso con texto alternativo, no debes depender únicamente de las imágenes para transmitir información. Asegúrate de que tu contenido describa lo que comunica la imagen. + +
+ ### Escribe texto alternativo eficaz +
+ +* **Sé específico**: Describe lo que muestra la imagen, no solo que es una imagen. +* **Sé conciso**: Limítate a una o dos frases. +* **Evita redundancias**: No empieces con "Imagen de" porque los lectores de pantalla ya saben que el texto alternativo está asociado a una imagen. Sin embargo, incluye descripciones como "Captura de pantalla de" o "Diagrama de" si ese contexto es importante para la imagen. + +```mdx + +![Captura de pantalla del dashboard que muestra tres proyectos activos y dos invitaciones pendientes](/images/dashboard.png) + + +![Captura de pantalla del dashboard](/images/dashboard.png) +``` + + +
+ ### Añade texto alternativo a las imágenes +
+ +Para las imágenes en Markdown, incluye el texto alternativo entre corchetes: + +```mdx +![Descripción de la imagen](/path/to/image.png) +``` + +Para las imágenes en HTML, usa el atributo `alt`: + +```html +Panel de configuración con opciones de accesibilidad activadas. Las opciones están destacadas con un rectángulo naranja. +``` + + +
+ ### Añade títulos al contenido incrustado +
+ +Los iframes y las inserciones de video requieren títulos descriptivos: + +```html + +``` + + +
+ ## Diseña para mejorar la legibilidad +
+ +Las decisiones de diseño visual afectan cuán accesible es tu documentación para personas con baja visión, daltonismo u otras discapacidades visuales. + +
+ ### Asegúrate de un contraste de color suficiente +
+ +Si personalizas los colores del tema, verifica que las relaciones de contraste cumplan los requisitos de las WCAG: + +- Texto de párrafo: relación de contraste mínima de 4.5:1 +- Texto grande: relación de contraste mínima de 3:1 +- Elementos interactivos: relación de contraste mínima de 3:1 + +Prueba tanto el modo claro como el oscuro. El comando `mint a11y` comprueba el contraste de color. + +
+ ### No dependas solo del color +
+ +Si usas el color para transmitir información, incluye también una etiqueta de texto o un icon. Por ejemplo, no marques los errores únicamente con texto rojo. Incluye un icono de error o la palabra "Error". + +
+ ### Usa un lenguaje claro y conciso +
+ +- Escribe en lenguaje sencillo. +- Define los términos técnicos la primera vez que los uses. +- Evita las oraciones largas o enrevesadas. +- Utiliza la voz activa. + +
+ ## Haz que los ejemplos de código sean accesibles +
+ +Los bloques de código son una parte fundamental de la documentación técnica, pero requieren consideraciones específicas de accesibilidad para garantizar que las personas que usan lectores de pantalla puedan comprenderlos. En general, sigue estas pautas: + +- Divide los ejemplos de código largos en fragmentos más pequeños y con sentido. +- Comenta la lógica compleja dentro del código. +- Considera proporcionar una descripción en texto para algoritmos complejos. +- Al mostrar la estructura de archivos, usa bloques de código reales con etiquetas de lenguaje en lugar de arte ASCII. + +
+ ### Especifica el lenguaje de programación +
+ +Declara siempre el lenguaje para el resaltado de sintaxis. Esto ayuda a los lectores de pantalla a anunciar el contexto del código a los usuarios: + +````mdx +```javascript +function obtenerDatosUsuario(id) { + return fetch(`/api/users/${id}`); +} +``` +```` + + +
+ ### Proporciona contexto del código +
+ +Proporciona contexto claro para los bloques de código: + +````mdx +La siguiente función obtiene datos de usuario desde la API: + +```javascript +function getUserData(id) { + return fetch(`/api/users/${id}`); +} +``` + +Esto devuelve una promesa que se resuelve en el objeto de usuario. +```` + + +
+ ## Accesibilidad de vídeo y multimedia +
+ +Los vídeos, las animaciones y otros contenidos multimedia necesitan alternativas textuales para que todas las personas puedan acceder a la información que contienen. + +
+ ### Agrega subtítulos a los videos +
+ +Los subtítulos hacen que el contenido de video sea accesible para personas sordas o con discapacidad auditiva. También ayudan a quienes están en entornos sensibles al sonido y a hablantes no nativos: + +- Usa subtítulos para todo el contenido hablado en los videos. +- Incluye efectos de sonido relevantes en los subtítulos. +- Asegúrate de que los subtítulos estén sincronizados con el audio. +- Usa puntuación adecuada e identifica a los interlocutores cuando hablen varias personas. + +La mayoría de las plataformas de alojamiento de videos admiten subtítulos. Sube archivos de subtítulos o usa subtítulos generados automáticamente como punto de partida y luego revísalos para verificar su precisión. + +
+ ### Proporciona transcripciones +
+ +Las transcripciones ofrecen una forma alternativa de acceder al contenido de video. Se pueden buscar, son más fáciles de consultar y accesibles para los lectores de pantalla: + +```mdx + + + +En este tutorial, veremos cómo configurar la autenticación... + +``` + +Coloca las transcripciones junto al video o proporciona un enlace claro para acceder a ellas. + + +
+ ### Considera alternativas al contenido exclusivamente en video +
+ +Si la información crítica solo aparece en un video: + +- Proporciona la misma información en formato de texto. +- Incluye capturas de pantalla clave con texto alternativo descriptivo. +- Crea un tutorial escrito que cubra el mismo material. + +Esto garantiza que los usuarios que no pueden acceder al contenido en video puedan igualmente completar su tarea. + +
+ ## Prueba tu documentación +
+ +Probar con regularidad te ayuda a detectar problemas de accesibilidad antes de que los usuarios se encuentren con ellos. + +
+ ### Detecta problemas de accesibilidad con `mint a11y` +
+ +Usa el comando de la CLI `mint a11y` para analizar automáticamente tu documentación en busca de problemas de accesibilidad comunes: + +```bash +mint a11y +``` + +El comando verifica: + +* Falta de texto alternativo en imágenes +* Jerarquía incorrecta de encabezados +* Contraste de color insuficiente + +Cuando finalice el análisis, revisa los problemas detectados y corrígelos en tu contenido. Ejecuta el comando de nuevo para verificar tus correcciones. + + +
+ ### Prueba básica de navegación con teclado +
+ +Navega por tu documentación usando solo el teclado: + +1. Pulsa Tab para avanzar por los elementos interactivos. +2. Pulsa Shift + Tab para retroceder. +3. Pulsa Enter para activar enlaces y botones. +4. Comprueba que todos los elementos interactivos sean accesibles y tengan indicadores de foco visibles. + +
+ ### Profundiza en las pruebas de accesibilidad +
+ +Para realizar pruebas más completas: + +- **Lectores de pantalla**: Prueba con [NVDA (Windows)](https://www.nvaccess.org/) o [VoiceOver (Mac)](https://www.apple.com/accessibility/voiceover/). +- **Extensiones del navegador**: Instala [axe DevTools](https://www.deque.com/axe/browser-extensions/) o [WAVE](https://wave.webaim.org/extension/) para analizar páginas y detectar problemas. +- **Pautas WCAG**: Revisa las [Pautas de Accesibilidad para el Contenido Web](https://www.w3.org/WAI/WCAG22/quickref/) para conocer los estándares en detalle. + +
+ ## Recursos adicionales +
+ +Sigue aprendiendo sobre accesibilidad con estos recursos de confianza: + +- **[WebAIM](https://webaim.org/)**: Artículos y tutoriales prácticos sobre accesibilidad web +- **[The A11y Project](https://www.a11yproject.com/)**: Recursos de accesibilidad de la comunidad y una lista de comprobación +- **[W3C Web Accessibility Initiative (WAI)](https://www.w3.org/WAI/)**: Normas oficiales de accesibilidad y guías \ No newline at end of file diff --git a/fr/guides/accessibility.mdx b/fr/guides/accessibility.mdx new file mode 100644 index 000000000..91970ded4 --- /dev/null +++ b/fr/guides/accessibility.mdx @@ -0,0 +1,398 @@ +--- +title: "Accessibilité" +description: "Créez une documentation utilisable par le plus grand nombre" +--- + +Lorsque vous créez une documentation accessible, vous privilégiez une conception du contenu qui la rend utilisable par le plus grand nombre, quel que soit le moyen d’accès et la manière d’interagir avec elle. + +La documentation accessible améliore l’expérience utilisateur pour tous. Votre contenu est plus clair, mieux structuré et plus facile à parcourir. + +Ce guide propose quelques bonnes pratiques pour créer une documentation accessible, mais il n’est pas exhaustif. Considérez l’accessibilité comme un processus continu. Les technologies et les normes évoluent avec le temps, offrant de nouvelles opportunités d’améliorer la documentation. + +
+ ## Qu’est-ce que l’accessibilité ? +
+ +L’accessibilité (parfois abrégée en a11y, pour le nombre de lettres entre la première et la dernière lettre d’« accessibility ») consiste à concevoir et à développer, de manière intentionnelle, des sites web et des outils utilisables par le plus grand nombre. Les personnes ayant un handicap temporaire ou permanent doivent bénéficier du même niveau d’accès aux technologies numériques. Concevoir pour l’accessibilité profite à tout le monde, y compris aux personnes qui consultent votre site web sur mobile ou via des réseaux lents. + +Une documentation accessible respecte les normes d’accessibilité du web, principalement les [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/WAI/WCAG22/quickref/). Ces directives aident à garantir que votre contenu est perceptible, opérable, compréhensible et robuste. + +
+ ## Premiers pas avec l’accessibilité +
+ +Rendre votre documentation accessible est un processus. Vous n’avez pas à tout corriger d’un coup et ce n’est pas quelque chose que l’on fait une seule fois. + +Si vous commencez tout juste à mettre en place des pratiques d’accessibilité pour votre documentation, envisagez une approche progressive : commencez par les changements à fort impact, puis étoffez progressivement. + +
+ ### Premiers pas +
+ +Voici trois actions que vous pouvez entreprendre dès maintenant pour améliorer l’accessibilité de votre documentation : + +1. **Exécutez `mint a11y`** pour identifier les problèmes d’accessibilité dans votre contenu. +2. **Ajoutez un texte alternatif (alt text)** à toutes les images. +3. **Vérifiez la hiérarchie des titres** pour garantir un seul H1 par page et des titres qui se suivent dans l’ordre. + +
+ ### Planifiez votre travail en matière d’accessibilité +
+ +Le meilleur flux de travail est celui qui convient à votre équipe. Voici une approche possible de l’accessibilité : + +**Phase 1 : Images et structure** + +- Passez en revue toutes les images pour vérifier la présence d’un texte alternatif descriptif. +- Passez en revue les textes de lien et remplacez les formules génériques comme « cliquez ici ». +- Corrigez les problèmes de hiérarchie des titres dans l’ensemble de votre documentation. + +**Phase 2 : Navigation et médias** + +- Testez la navigation au clavier sur votre documentation. +- Testez la compatibilité avec les lecteurs d’écran. +- Ajoutez des sous-titres et des transcriptions aux vidéos intégrées. +- Vérifiez le contraste des couleurs. + +**Phase 3 : Intégrez-la à votre flux de travail** + +- Exécutez `mint a11y` avant de publier un nouveau contenu. +- Intégrez des vérifications d’accessibilité à votre processus de relecture de contenu. +- Testez la navigation au clavier lors de l’ajout de fonctionnalités interactives. +- Vérifiez que les nouveaux liens externes et contenus intégrés incluent des titles et descriptions appropriés. + +Commencer modestement et intégrer l’accessibilité à votre flux de travail habituel la rend pérenne. Chaque amélioration aide davantage d’utilisateurs à accéder avec succès à votre documentation. + +
+ ## Structurez votre contenu +
+ +Un contenu bien structuré est plus facile à parcourir et à comprendre, surtout pour les utilisateurs de lecteurs d’écran qui s’appuient sur les titres pour se déplacer dans les pages, ainsi que pour les personnes qui utilisent la navigation au clavier. + +
+ ### Utilisez une hiérarchie de titres correcte +
+ +Chaque page doit comporter un seul titre H1, défini par la propriété `title:` dans le frontmatter de la page. Utilisez ensuite les niveaux de titres dans l’ordre sans en sauter. Par exemple, ne passez pas de H2 à H4. + +```mdx + +# Titre de la page (H1) + +## Section principale (H2) + +### Sous-section (H3) + +### Autre sous-section (H3) + +## Autre section principale (H2) + + +# Titre de la page (H1) + +## Section principale (H2) + +#### Sous-section (H4) + +### Autre sous-section (H3) +``` + +Les titres d’un même niveau doivent avoir des noms uniques. + +```mdx + +## Conseils d'accessibilité (H2) + +### Rédiger un texte alternatif efficace (H3) + +### Utiliser un contraste de couleur approprié (H3) + + +## Conseils d'accessibilité (H2) + +### Conseil (H3) + +### Conseil (H3) +``` + + + + +Le texte du lien doit être explicite et refléter la destination. Évitez les formulations vagues comme « cliquez ici » ou « en savoir plus ». + +```mdx + +Découvrez comment [configurer votre navigation](/organize/navigation). + + +[En savoir plus](/organize/navigation). +``` + + +
+ ### Facilitez le survol du contenu +
+ +- Scindez les longs paragraphes. +- Utilisez des listes pour les étapes et les options. +- Mettez en avant les informations avec des encadrés. + +
+ ### Utilisez une structure de tableau appropriée +
+ +N’utilisez les tableaux qu’avec parcimonie et uniquement pour des données tabulaires dont la signification découle des en-têtes de colonnes et de lignes. + +Lorsque vous utilisez des tableaux, incluez des en-têtes afin que les lecteurs d’écran puissent associer les données à la bonne colonne : + +```mdx +| Fonctionnalité | Statut | +| -------------- | ------ | +| Recherche | Actif | +| Analytics | Actif | +``` + + +
+ ## Rédiger un texte alternatif descriptif +
+ +Le texte alternatif rend les images accessibles aux utilisateurs de lecteurs d’écran et s’affiche lorsque les images ne se chargent pas. Les images de votre documentation doivent comporter un texte alternatif qui décrit l’image et précise clairement pourquoi elle est incluse. Même avec un texte alternatif, ne vous fiez pas uniquement aux images pour transmettre des informations. Assurez-vous que votre contenu décrit ce que l’image communique. + +
+ ### Rédigez un texte alternatif efficace +
+ +* **Soyez précis** : Décrivez ce que montre l’image, pas seulement que c’est une image. +* **Soyez concis** : Contentez-vous d’une à deux phrases. +* **Évitez les redondances** : Ne commencez pas par « Image de » car les lecteurs d’écran savent déjà que le texte alternatif est associé à une image. En revanche, incluez des formulations comme « Capture d’écran de » ou « Schéma de » si ce contexte est important pour l’image. + +```mdx + +![Capture d'écran du Dashboard montrant trois projets actifs et deux invitations en attente](/images/dashboard.png) + + +![Capture d'écran du Dashboard](/images/dashboard.png) +``` + + +
+ ### Ajouter un texte alternatif aux images +
+ +Pour les images en Markdown, ajoutez un texte alternatif entre crochets : + +```mdx +![Description de l'image](/path/to/image.png) +``` + +Pour les images HTML, utilisez l’attribut « alt » : + +```html +Panneau de paramètres avec les options d'accessibilité activées. Les options sont mises en évidence par un rectangle orange. +``` + + +
+ ### Ajouter des titres au contenu intégré +
+ +Les iframes et les vidéos intégrées doivent avoir des titres descriptifs : + +```html + +``` + + +
+ ## Concevoir pour la lisibilité +
+ +Les choix de conception visuelle influencent l’accessibilité de votre documentation pour les personnes ayant une basse vision, un daltonisme ou d’autres déficiences visuelles. + +
+ ### Assurez un contraste de couleurs suffisant +
+ +Si vous personnalisez les couleurs de votre thème, vérifiez que les taux de contraste respectent les exigences WCAG : + +- Texte courant : taux de contraste minimal de 4,5:1 +- Texte large : taux de contraste minimal de 3:1 +- Éléments interactifs : taux de contraste minimal de 3:1 + +Testez le mode light et le mode sombre. La commande `mint a11y` vérifie le contraste des couleurs. + +
+ ### Ne vous fiez pas uniquement à la couleur +
+ +Si vous utilisez la couleur pour transmettre une information, ajoutez également un libellé textuel ou une icône. Par exemple, ne signalez pas les erreurs uniquement avec du texte rouge. Ajoutez une icône d’erreur ou le mot « Erreur ». + +
+ ### Utilisez un langage clair et concis +
+ +- Écrivez en langage simple. +- Définissez les termes techniques lors de leur première occurrence. +- Évitez les phrases à rallonge. +- Employez la voix active. + +
+ ## Rendre les exemples de code accessibles +
+ +Les code blocks sont un élément essentiel de la documentation technique, mais ils nécessitent des considérations d’accessibilité spécifiques pour que les utilisateurs de lecteurs d’écran puissent les comprendre. De manière générale, suivez ces recommandations : + +- Divisez les longs exemples de code en sections plus petites et cohérentes. +- Commentez la logique complexe dans le code. +- Envisagez de fournir une description textuelle pour les algorithmes complexes. +- Lors de la présentation d’une arborescence de fichiers, utilisez de vrais code blocks avec des labels de langage plutôt que de l’art ASCII. + +
+ ### Indiquez le langage de programmation +
+ +Déclarez toujours la langue pour la coloration syntaxique. Cela aide les lecteurs d’écran à annoncer le contexte du code aux utilisateurs : + +````mdx +```javascript +function getUserData(id) { + return fetch(`/api/users/${id}`); +} +``` +```` + + +
+ ### Fournir du contexte autour du code +
+ +Fournissez un contexte clair pour les code block : + +````mdx +La fonction suivante récupère les données utilisateur depuis l'API : + +```javascript +function getUserData(id) { + return fetch(`/api/users/${id}`); +} +``` + +Cela retourne une promesse qui se résout vers l'objet utilisateur. +```` + + +
+ ## Accessibilité des vidéos et des contenus multimédias +
+ +Les vidéos, animations et autres contenus multimédias doivent être accompagnés d’alternatives textuelles afin que tous les utilisateurs puissent accéder aux informations qu’ils contiennent. + +
+ ### Ajouter des sous-titres aux vidéos +
+ +Les sous-titres rendent le contenu vidéo accessible aux personnes sourdes ou malentendantes. Ils aident aussi les utilisateurs dans des environnements sensibles au bruit ainsi que les personnes non natives : + +- Utilisez des sous-titres pour tout le contenu parlé des vidéos. +- Incluez les effets sonores pertinents dans les sous-titres. +- Assurez-vous que les sous-titres sont synchronisés avec l’audio. +- Utilisez une ponctuation appropriée et identifiez les locuteurs lorsque plusieurs personnes parlent. + +La plupart des plateformes d’hébergement vidéo permettent d’ajouter des sous-titres. Importez des fichiers de sous-titres ou utilisez des sous-titres générés automatiquement comme point de départ, puis vérifiez leur exactitude. + +
+ ### Fournir des transcriptions +
+ +Les transcriptions offrent un autre moyen d’accéder au contenu vidéo. Elles sont consultables par recherche, plus faciles à référencer et accessibles aux lecteurs d’écran : + +```mdx + + + +Dans ce tutoriel, nous allons voir comment configurer l'authentification... + +``` + +Placez les transcriptions à proximité de la vidéo ou fournissez un lien clair pour y accéder. + + +
+ ### Envisagez des alternatives au contenu exclusivement vidéo +
+ +Si des informations essentielles ne figurent que dans une vidéo : + +- Fournissez les mêmes informations sous forme de texte. +- Ajoutez des captures d’écran clés avec un texte alternatif descriptif. +- Rédigez un tutoriel qui couvre la même matière. + +Ainsi, les utilisateurs qui n’ont pas accès au contenu vidéo peuvent tout de même mener à bien leur tâche. + +
+ ## Testez votre documentation +
+ +Des tests réguliers vous aident à repérer les problèmes d’accessibilité avant que les utilisateurs ne les rencontrent. + +
+ ### Vérifiez les problèmes d’accessibilité avec `mint a11y` +
+ +Utilisez la commande d’interface en ligne de commande (CLI) `mint a11y` pour analyser automatiquement votre documentation à la recherche de problèmes d’accessibilité courants : + +```bash +mint a11y +``` + +La commande vérifie : + +* Texte alternatif manquant pour les images +* Hiérarchie des titres incorrecte +* Contraste des couleurs insuffisant + +Lorsque l’analyse est terminée, passez en revue les problèmes signalés et corrigez-les dans votre objet. Exécutez de nouveau la commande pour valider vos corrections. + + +
+ ### Test de base de la navigation au clavier +
+ +Parcourez votre documentation en utilisant uniquement votre clavier : + +1. Appuyez sur Tab pour avancer dans les éléments interactifs. +2. Appuyez sur Shift + Tab pour revenir en arrière. +3. Appuyez sur Enter pour activer les liens et les boutons. +4. Vérifiez que tous les éléments interactifs sont accessibles et affichent un indicateur de focus visible. + +
+ ### Approfondissez vos tests d’accessibilité +
+ +Pour des évaluations plus complètes : + +- **Lecteurs d’écran** : Testez avec [NVDA (Windows)](https://www.nvaccess.org/) ou [VoiceOver (Mac)](https://www.apple.com/accessibility/voiceover/). +- **Extensions de navigateur** : Installez [axe DevTools](https://www.deque.com/axe/browser-extensions/) ou [WAVE](https://wave.webaim.org/extension/) pour analyser les pages et détecter les problèmes. +- **Directives WCAG** : Consultez les [Web Content Accessibility Guidelines](https://www.w3.org/WAI/WCAG22/quickref/) pour connaître les normes détaillées. + +
+ ## Ressources supplémentaires +
+ +Approfondissez vos connaissances en accessibilité avec ces ressources de confiance : + +- **[WebAIM](https://webaim.org/)** : articles et tutoriels pratiques sur l’accessibilité du web +- **[The A11y Project](https://www.a11yproject.com/)** : ressources communautaires et liste de vérification sur l’accessibilité +- **[W3C Web Accessibility Initiative (WAI)](https://www.w3.org/WAI/)** : normes officielles et recommandations en matière d’accessibilité \ No newline at end of file diff --git a/zh/guides/accessibility.mdx b/zh/guides/accessibility.mdx new file mode 100644 index 000000000..aa7d5af14 --- /dev/null +++ b/zh/guides/accessibility.mdx @@ -0,0 +1,398 @@ +--- +title: "无障碍" +description: "编写尽可能多的人都能使用的文档" +--- + +当你编写无障碍文档时,会优先采用让尽可能多的人都能使用的内容设计,无论他们以何种方式访问和与文档交互。 + +无障碍文档能提升所有人的使用体验。你的内容会更清晰、结构更合理,也更易于浏览和导航。 + +本指南提供了一些创建无障碍文档的最佳实践,但并不全面。你应将无障碍视为一项持续的工作。随着时间推移,技术和标准不断变化,这也带来了改进文档的新机会。 + +
+ ## 什么是无障碍? +
+ +无障碍(有时缩写为 a11y,意指“accessibility”首尾字母之间的 11 个字母)是指有意识地设计和构建尽可能多的人都能使用的网站和工具。无论是临时还是永久性的残障人士,都应当享有与他人同等水平的数字技术可达性。而为无障碍而设计也能惠及所有人,包括那些通过移动设备或在慢速网络上访问你网站的用户。 + +无障碍的文档应遵循网页无障碍标准,主要是 [网页内容无障碍指南(WCAG)](https://www.w3.org/WAI/WCAG22/quickref/)。这些指南有助于确保你的内容具有可感知、可操作、可理解和健壮性等特征。 + +
+ ## 无障碍入门 +
+ +让你的文档具备可访问性是一个过程。你不必一次性修复所有问题,也不能一次完成就了事。 + +如果你刚开始为文档落实无障碍实践,可以考虑采取分阶段的方法:先从影响最大的改动入手,再循序推进。 + +
+ ### 入门 +
+ +以下是你现在就可以采取的三项措施,来提升文档的可访问性: + +1. **运行 `mint a11y`**,识别 content 中的可访问性问题。 +2. **为所有图片添加替代文本(alt text)**。 +3. **检查标题层级**,确保每页只有一个 H1,且各级标题按顺序递进。 + +
+ ### 规划你的无障碍工作 +
+ +最好的工作流程是最适合你团队的那个。下面是开展无障碍工作的一个可行方法: + +**阶段 1:图像与结构** + +- 检查所有图像是否包含具有描述性的 alt 文本。 +- 审核链接文本,替换“点击这里”等泛泛表述。 +- 修复整份文档中的标题层级问题。 + +**阶段 2:导航与媒体** + +- 在文档中测试键盘导航。 +- 测试屏幕阅读器兼容性。 +- 为嵌入视频添加字幕和文字稿。 +- 检查颜色对比度。 + +**阶段 3:融入你的工作流程** + +- 在发布新内容前运行 `mint a11y`。 +- 将无障碍检查纳入内容评审流程。 +- 添加交互功能时测试键盘导航。 +- 确认新的外部链接和嵌入包含合适的标题和说明。 + +从小处着手,并将无障碍纳入日常工作流程,才能长期坚持。每一次改进都能帮助更多用户顺利使用你的文档。 + +
+ ## 结构化你的内容 +
+ +结构清晰的内容更便于浏览和理解,尤其有助于依靠标题在页面间移动的屏幕阅读器用户,以及使用键盘进行导航的用户。 + +
+ ### 使用正确的标题层级 +
+ +每个页面应只有一个 H1 标题,该标题由页面 frontmatter 中的 `title:` 属性定义。按顺序使用后续标题,避免跳级。例如,不要从 H2 直接跳到 H4。 + +```mdx + +# 页面标题 (H1) + +## 主要章节 (H2) + +### 子章节 (H3) + +### 另一个子章节 (H3) + +## 另一个主要章节 (H2) + + +# 页面标题 (H1) + +## 主要章节 (H2) + +#### 子章节 (H4) + +### 另一个子章节 (H3) +``` + +同一层级的标题应具有唯一名称。 + +```mdx + +## 无障碍功能提示 (H2) + +### 编写有效的替代文本 (H3) + +### 使用适当的颜色对比度 (H3) + + +## 无障碍功能提示 (H2) + +### 提示 (H3) + +### 提示 (H3) +``` + + + + +链接文本应当有意义,并清楚表明其指向的内容。避免使用诸如 “点击这里” 或 “了解更多” 这类含糊的表述。 + +```mdx + +了解如何[配置您的导航](/organize/navigation)。 + + +[了解更多](/organize/navigation)。 +``` + + +
+ ### 让内容便于快速浏览 +
+ +- 拆分长段落。 +- 使用列表呈现步骤和选项。 +- 通过提示框突出关键信息。 + +
+ ### 使用正确的表格结构 +
+ +尽量少用表格,仅在需要呈现由行列标题传达含义的表格数据时使用。 + +使用表格时,请包含表头,以便屏幕阅读器能将数据与正确的列关联: + +```mdx +| 功能 | 状态 | +| ------- | ------ | +| 搜索 | 启用 | +| Analytics | 启用 | +``` + + +
+ ## 撰写具描述性的替代文字 +
+ +替代文字有助于屏幕阅读器用户理解图像,并会在图像加载失败时显示。文档中的图像应包含能够描述图像并清楚说明其用途或包含原因的替代文字。即使提供了替代文字,也不应仅依赖图像来传达信息。请确保你的内容能够表达图像所传达的要点。 + +
+ ### 编写有效的替代文本(alt text) +
+ +* **具体明确**:描述图像所展示的内容,而不是只说明这是一张图片。 +* **简洁凝练**:控制在一到两句话。 +* **避免冗余**:不要以“Image of”开头,因为屏幕阅读器已经知道替代文本与图像相关。但如果这些信息对图像的 context 很重要,可以包含诸如“Screenshot of”或“Diagram of”之类的描述。 + +```mdx + +![控制台截图,显示三个活跃项目和两个待处理邀请](/images/dashboard.png) + + +![控制台截图](/images/dashboard.png) +``` + + +
+ ### 为图像添加替代文本(alt text) +
+ +对于 Markdown 图像,请在方括号中填写替代文本: + +```mdx +![图片说明](/path/to/image.png) +``` + +对于 HTML 图片,请使用 `alt` 属性: + +```html +设置面板,已启用无障碍功能选项。选项以橙色矩形框突出显示。 +``` + + +
+ ### 为嵌入内容添加标题 +
+ +iframe 和视频嵌入需要提供描述性标题: + +```html + +``` + + +
+ ## 为可读性而设计 +
+ +视觉设计的取舍会影响低视力、色盲或其他视觉障碍用户获取你文档信息的可访问性。 + +
+ ### 确保足够的色彩对比度 +
+ +如果你自定义了主题颜色,请确认对比度符合 WCAG 要求: + +- 正文:最低 4.5:1 对比度 +- 大号文本:最低 3:1 对比度 +- 交互元素:最低 3:1 对比度 + +请同时测试 light 与深色模式。`mint a11y` 命令会检查色彩对比度。 + +
+ ### 不要仅依赖颜色 +
+ +如果你用颜色来传达信息,请同时加入文本标签或 icon。例如,不要仅用红色文字标记错误;请加入错误 icon 或“错误”一词。 + +
+ ### 使用清晰、简洁的语言 +
+ +- 使用通俗易懂的表达。 +- 首次出现时定义技术术语。 +- 避免连写长句。 +- 使用主动语态。 + +
+ ## 让代码示例更具可访问性 +
+ +代码块是技术文档的重要组成部分,但为确保屏幕阅读器用户能理解,它们需要特定的无障碍设计考量。一般而言,请遵循以下指南: + +- 将较长的代码示例拆分为更小且逻辑清晰的片段。 +- 在代码中为复杂逻辑添加注释。 +- 考虑为复杂算法提供文字说明。 +- 展示文件结构时,使用带语言标签的实际代码块,而非 ASCII 艺术。 + +
+ ### 指定编程语言 +
+ +务必为语法高亮声明所用语言。这有助于屏幕阅读器向用户说明代码的 context: + +````mdx +```javascript +function getUserData(id) { + return fetch(`/api/users/${id}`); +} +``` +```` + + +
+ ### 为代码提供上下文 +
+ +为代码块提供清晰的上下文: + +````mdx +以下函数从 API 获取用户数据: + +```javascript +function getUserData(id) { + return fetch(`/api/users/${id}`); +} +``` + +这将返回一个解析为用户对象的 Promise。 +```` + + +
+ ## 视频与多媒体的可访问性 +
+ +视频、动画及其他多媒体内容需要提供文本替代,确保所有用户都能获取其中的信息。 + +
+ ### 为视频添加字幕 +
+ +字幕可让聋人或听力障碍用户更便捷地获取视频内容,也能帮助处于对声音敏感环境的用户以及非母语使用者: + +- 为视频中的所有口语内容提供字幕。 +- 在字幕中包含相关的音效描述。 +- 确保字幕与音频同步。 +- 当多人发言时,使用正确的标点并标注说话者。 + +大多数视频托管平台都支持添加字幕。可上传字幕文件,或先使用自动生成的字幕作为基础,再进行准确性校对。 + +
+ ### 提供文字稿 +
+ +文字稿为获取视频内容提供了一种替代方式。它可被搜索、更便于引用,并且对屏幕阅读器更加友好: + +```mdx + + + +在本教程中,我们将逐步介绍如何设置认证... + +``` + +将文字稿放在视频附近,或提供明确的访问链接。 + + +
+ ### 考虑提供视频内容以外的替代方案 +
+ +如果关键信息只出现在视频中: + +- 提供等效的文本版本。 +- 附上关键截图,并配有描述性替代文本(alt 文本)。 +- 编写涵盖同样内容的图文教程。 + +这样可确保无法访问视频内容的用户仍然能够完成其任务。 + +
+ ## 测试你的文档 +
+ +定期测试可在用户遇到问题之前发现无障碍问题。 + +
+ ### 使用 `mint a11y` 检查无障碍问题 +
+ +使用 `mint a11y` 命令行界面(CLI)命令自动扫描文档,检测常见的无障碍问题: + +```bash +mint a11y +``` + +该命令会检查: + +* 图像缺少替代文本(alt) +* 标题层级不正确 +* 颜色对比度不足 + +扫描完成后,查看报告的问题并在你的内容中修复它们。再次运行该命令以验证修复结果。 + + +
+ ### 基本键盘导航测试 +
+ +仅使用键盘浏览文档: + +1. 按 Tab 在交互元素间向前移动。 +2. 按 Shift + Tab 向后移动。 +3. 按 Enter 激活链接和按钮。 +4. 确认所有交互元素均可到达,并具有可见的焦点指示。 + +
+ ### 深入开展无障碍测试 +
+ +如需进行更全面的测试: + +- **屏幕阅读器**:使用 [NVDA(Windows)](https://www.nvaccess.org/) 或 [VoiceOver(Mac)](https://www.apple.com/accessibility/voiceover/) 进行测试。 +- **浏览器扩展**:安装 [axe DevTools](https://www.deque.com/axe/browser-extensions/) 或 [WAVE](https://wave.webaim.org/extension/),对页面进行问题扫描。 +- **WCAG 指南**:查阅 [Web Content Accessibility Guidelines](https://www.w3.org/WAI/WCAG22/quickref/),了解详细标准。 + +
+ ## 其他资源 +
+ +通过以下权威资源继续学习无障碍: + +- **[WebAIM](https://webaim.org/)**:关于网页无障碍的实用文章与教程 +- **[The A11y Project](https://www.a11yproject.com/)**:社区驱动的无障碍资源与检查清单 +- **[W3C Web Accessibility Initiative (WAI)](https://www.w3.org/WAI/)**:官方无障碍标准与指南 \ No newline at end of file