Guía de estilo y modelo de contenido
Obtenga información sobre cómo hacemos que la documentación de GitHub sea coherente, fácil de seguir y de mantener.
Guía de estilo
Sigue esta guía para asegurarte de que la documentación de GitHub es coherente y sigue patrones claros que nuestros lectores puedan entender.
Acerca del modelo de contenido
El modelo de contenido describe la estructura y los tipos de contenido que publicamos.
Contenido de un artículo de Documentación de GitHub
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.
Acerca de los temas
Use temas para hacer que los artículos se puedan buscar.
Tipo de contenido conceptual
Los usuarios utilizan con más frecuencia el contenido conceptual cuando están aprendiendo sobre algo nuevo para ellos.
Tipo de contenido referencial
El contenido referencial proporciona información detallada que los usuarios necesitan mientras están usando una característica.
Tipo de contenido de procedimientos
El contenido de procedimientos proporciona contexto sobre cómo encaja la tarea en el objetivo más amplio de alguien.
Tipo de contenido de solución de problemas
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.
Tipo de contenido de la nota de versión
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.
Tipo de contenido de inicio rápido
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.
Tipo de contenido del tutorial
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
Combinación de varios tipos de contenido
Puede combinar varios tipos de contenido en un solo artículo para ayudar a los usuarios a completar tareas complejas.