Skip to main content

Acerca de la filosofía de la documentación de GitHub

Nuestra filosofía de la documentación guía el contenido que creamos y cómo lo creamos.

Acerca de la filosofía de la documentación de GitHub

Como hogar de la comunidad de desarrolladores más grande del mundo, queremos asegurarnos de que nuestra documentación sea precisa, valiosa, inclusiva y fácil de usar. Nuestra filosofía de la documentación nos conduce hacia estos objetivos.

  • Abogamos por nuestros usuarios. Esto puede ocurrir en cualquier momento del proceso de documentación, desde el planeamiento hasta la escritura y la publicación. Respondemos a los comentarios y trabajamos proactivamente para crear la mejor experiencia de usuario posible en el sitio de GitHub Docs.
  • Escribimos para un público internacional, de modo que nuestro contenido se pueda traducir e incluya a todos los usuarios.
  • Creamos contenido al que puede acceder un amplio grupo de usuarios. Nuestro kit de herramientas de contenido incluye recursos e instrucciones para reducir las barreras para los usuarios con discapacidades y, de forma prioritaria, nos mantenemos al día con los estándares de accesibilidad más recientes.
  • Creamos contenido basado en tareas. Consideramos cuál es la meta de los usuarios cuando utilizan GitHub para después crear contenido que les ayude a alcanzar sus objetivos y descubrir nuevas posibilidades.
  • Colaboramos con equipos de GitHub y la comunidad de código abierto para crear contenido de alta calidad.
  • Aprendemos y mejoramos continuamente para mantener la mejor experiencia para todos aquellos que usan GitHub.