Skip to main content

Escritura para GitHub Docs

Obtenga información sobre cómo escribir para GitHub Docs.

Procedimientos recomendados para documentos de GitHub

Siga estos procedimientos recomendados para crear documentación fácil de usar y de entender.

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.

Principios del diseño de contenido

Compartimos estos principios para diseñar y crear el mejor contenido para quienes usan GitHub.

Escritura de contenido que se va a traducir

Nuestra documentación se traduce a varios idiomas. La forma en la que redactamos la documentación en inglés puede mejorar considerablemente la calidad de esas traducciones.

Hacer que el contenido se pueda encontrar en la búsqueda

Sigue estos procedimientos recomendados de SEO para ayudar a los usuarios a encontrar documentación de GitHub mediante motores de búsqueda.

Documentación sobre el control de versiones

GitHub Docs utiliza texto preliminar de YAML y operadores Liquid para admitir varias versiones de GitHub con un enfoque de origen único.

Uso de Markdown y Liquid en la documentación de GitHub

Puedes usar Markdown y Liquid para dar formato al contenido, crear contenido reutilizable y escribir contenido para diferentes versiones en GitHub Docs.

Usar el texto preliminar de YAML

Puede usar el encabezado de YAML para definir el control de versiones, agregar metadatos y controlar el diseño de los artículos.

Uso de vídeos en GitHub Docs

En esta guía, se explica cómo crear vídeos que apoyen las necesidades de los usuarios respecto de GitHub Docs.

Creación de contenido reutilizable

Puedes crear contenido reutilizable al que se puede hacer referencia en varios archivos de contenido.

Creación de capturas de pantalla

Para ayudar a que los usuarios localicen los elementos de la interfaz de usuario que son difíciles de encontrar, agrega capturas de pantalla a GitHub Docs.

Crear diagramas para GitHub Docs

En esta guía, se explica cuándo y cómo crear diagramas de GitHub Docs.

Creación de conmutadores de herramientas en artículos

Puedes usar un conmutador de herramientas para mostrar cómo completar tareas mediante herramientas específicas.

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.

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.

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.

Plantillas

Este artículo contiene plantillas de inicio para los distintos tipos de contenido que se usan en GitHub Docs.