Guía de estilo y modelo de contenido

Sigue esta guía para asegurarte de que la documentación de GitHub es coherente y sigue patrones claros que nuestros lectores puedan entender.

El modelo de contenido describe la estructura y los tipos de contenido que publicamos.

Cada artículo incluye algunos elementos estándar y puede incluir elementos condicionales u opcionales. También usamos un orden estándar para el contenido de un artículo.

Use temas para hacer que los artículos se puedan buscar.

Los usuarios utilizan con más frecuencia el contenido conceptual cuando están aprendiendo sobre algo nuevo para ellos.

El contenido referencial proporciona información detallada que los usuarios necesitan mientras están usando una característica.

El contenido de procedimientos proporciona contexto sobre cómo encaja la tarea en el objetivo más amplio de alguien.

El contenido de solución de problemas incluye errores integrados que es probable que los usuarios encuentren, problemas comunes notificados al equipo de soporte técnico y situaciones en las que los usuarios se pueden encontrar cuando realizan tareas.

Las notas de la versión permiten a los lectores comprender y prepararse para los cambios que afectan al usuario en cada versión de los productos empresariales de GitHub.

Los inicios rápidos son mejores para quienes quieran instrucciones rápidamente sin explicaciones largas de cómo funciona algo o por qué querrían usarlo.

Los tutoriales son útiles cuando un usuario tiene un conocimiento básico del producto y está interesado en ampliar ese conocimiento para resolver un problema específico

Puede combinar varios tipos de contenido en un solo artículo para ayudar a los usuarios a completar tareas complejas.