Escritura para GitHub Docs

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

Nuestra filosofía de la documentación guía el contenido que creamos y cómo lo creamos.

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.

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

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

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

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

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

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

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.

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

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

Si cambia el título, la versión o la ubicación de un artículo, puedes crear un redireccionamiento al contenido actual.

Cuando sea necesario cambiar el título de un artículo, es posible que el nombre deba actualizarse en varios lugares.

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.

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