Contribución a la documentación de GitHub Docs
Obtén información sobre cómo el equipo de GitHub Docs crea documentación y cómo puedes contribuir.
Recomendado
Acerca de cómo contribuir a GitHub Docs
Puedes contribuir al contenido de GitHub Docs de varias formas.
Procedimientos recomendados para documentos de GitHub
Siga estos procedimientos recomendados para crear documentación fácil de usar y de entender.
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.
Artículos
Acerca de cómo contribuir a GitHub Docs
Puedes contribuir al contenido de GitHub Docs de varias formas.
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 los aspectos básicos de la documentación de GitHub
Todo el contenido publicado en GitHub Docs debe cumplir estos requisitos fundamentales.
Acerca del modelo de contenido
El modelo de contenido describe la estructura y los tipos de contenido que publicamos.
Anotación de ejemplos de código
Puedes anotar ejemplos de código más largos para explicar cómo funcionan y la forma en que los usuarios pueden personalizarlos para otros usos.
Cambio del título de un artículo
Cuando sea necesario cambiar el título de un artículo, es posible que el nombre deba actualizarse en varios lugares.
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.
Configuración de redireccionamientos
Si cambia el título, la versión o la ubicación de un artículo, puedes crear un redireccionamiento al contenido actual.
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.