Acerca de los aspectos básicos de la documentación de GitHub
Estos aspectos básicos son necesarios para la documentación de GitHub. Usa las listas siguientes como ayuda para asegurarte de que tus contribuciones sean precisas, accesibles, inclusivas y coherentes.
Precisos
La documentación es correcta y precisa.
- Asegúrate de que el contenido no tenga errores factuales.
- Asegúrate de que el contenido no tenga errores ortográficos ni de formato.
Accesible e inclusiva
La documentación está actualizada con los estándares de accesibilidad más recientes y está escrita para ser inclusiva y facilitar la traducción.
- Asegúrate de que el contenido se ajusta a las directrices de accesibilidad y captura de pantalla. Para más información, consulta Creación de capturas de pantalla.
- Asegúrate de que el contenido se pueda traducir correctamente. Para más información, consulta Escritura de contenido que se va a traducir.
Continuo
La documentación mantiene una voz, un tono y un estilo coherentes de principio a fin, lo cual crea una experiencia coherente para los lectores.
- Asegúrate de que el contenido se ajusta a la guía de estilo de GitHub Docs. Para más información, consulta Guía de estilo.
- Aplica convenciones de nomenclatura y terminología coherentes.
- Usa los elementos de personalización de marca (por ejemplo, nombres de productos y características, logotipos, combinaciones de colores) de forma coherente en todo el contenido.