Acerca de los principios del diseño de contenido de GitHub
Creamos documentación de productos que ayuda, enseña e involucra a todos quienes usan GitHub. Un paso de este trabajo es diseñar el contenido que escribimos. Seguimos estos principios al diseñar y planear contenido.
- Nuestro contenido está centrado en el usuario y es inclusivo. Respetamos a todas las personas que consultan la documentación y creamos contenido que les resulte útil con nuestras opciones de estrategia, diseño y estilo.
- El contenido que creamos explica por qué nuestros productos son útiles y ayudan a las personas a alcanzar sus objetivos y prioridades.
- Usamos nuestros recursos para crear documentación valiosa de alta calidad para la comunidad de GitHub.
- Creamos documentación suficiente, porque una mayor cantidad de contenido hace que todo sea más difícil de encontrar y todo lo que se agregue diluirá todo lo demás (GitHub Zen).
- Nuestro aprendizaje proviene de la iteración y la entrega: a medida que aprendemos cosas nuevas, ya sea de la experiencia, los conocimientos del sector y del trabajo con nuestra comunidad de GitHub Docs, ajustamos los procesos, los procedimientos y las directrices.
Proporcionamos una guía de estilo y modelos de contenido como elementos básicos y directrices para que cualquier persona diseñe y cree documentación.
- Nuestros modelos de contenido y nuestra guía de estilo se aplican a una variedad de escenarios.
- Las decisiones se basan en lo que es mejor para las personas que usan nuestra documentación y no simplemente en lo que es correcto o incorrecto según las reglas gramaticales o estilísticas. Somos flexibles y estamos abiertos a los cambios siempre y cuando se mantenga la coherencia.
- Nos centramos en documentar escenarios de alto impacto y valor en lugar de intentar abarcar completamente cada caso de uso posible para los muchos productos y características de GitHub.
- Nuestras prioridades más altas son la claridad, el significado, la corrección y la coherencia.
- Al tomar una decisión de estilo o estructura, tenemos en cuenta lo que las personas intentan hacer con la información y cómo el contenido puede apoyar mejor sus objetivos.
- Cuando la guía de estilo o el modelo de contenido no cubre algún aspecto específico sobre la documentación, se evalúa mediante estos principios y, a continuación, tomamos una decisión.