Los procedimientos contienen pasos numerados que explican cómo utilizar productos GitHub para llevar a cabo una tarea. Por lo general, son necesarios para sacar el máximo partido del uso de GitHub.
Los artículos de procedimientos se centran en los pasos esenciales mínimos para completar una tarea. Pueden vincularse a otros tipos de contenido como requisitos previos (especialmente conceptos o referencia) o pasos siguientes (especialmente tutoriales). En consonancia con nuestra estrategia de vinculación, solo se deben usar cuando sea explícitamente útil y necesario.
Por lo general, incluir 1-2 breves oraciones introductorias antes de los pasos está bien. Si se necesita más explicación más allá de un par de oraciones, considere la posibilidad de agregar la información en su lugar como un artículo conceptual.
La solución de problemas es su propio tipo de contenido, pero los artículos de procedimientos pueden incluir secciones breves de solución de problemas en las que esto ayuda a los usuarios a completar la tarea.
Títulos para artículos instructivos
Los títulos de los artículos instructivos y las secciones dentro de estos se basan en tareas y comienzan con un gerundio.
- Use: "Solicitar un paquete para desarrolladores estudiantes" Use verbos activos y específicos (lluvia de ideas o use un diccionario de sinónimos cuando sea necesario). Los títulos describen específicamente la tarea que contiene el artículo o encabezado, pero son lo suficientemente generales como para reflejar todo el contenido.
Los títulos cortos de los artículos de instrucciones utilizan frases verbales cortas y no gerundios. Los títulos cortos aparecen en la navegación lateral.
- Use: "Administrar el plan" o "Crear problemas con Copilot"
Consideraciones sobre procedimientos
Para obtener la plantilla de contenido de "cómo hacer", consulte Plantillas.
- Sigue las directrices para los pasos procedimentales en Guía de estilo.
- El contenido de procedimientos puede ser repetitivo: busque oportunidades para agrupar contenido relacionado en un solo artículo más largo.
- Agrupe varios procedimientos relacionados en un solo artículo a menos que no haya una razón convincente para no hacerlo.
- Si deshabilitar una configuración o deshacer una tarea requiere los mismos pasos y no tiene implicaciones especiales, no escriba un procedimiento independiente.
- Si deshabilitar una configuración o deshacer una tarea requiere pasos diferentes o tiene implicaciones importantes o especiales, cree un artículo más largo para contener ambos procedimientos.
- Incluya siempre el resultado previsto del procedimiento (por lo general, este será el título).
- Incluya sugerencias de solución de problemas en puntos débiles conocidos.
** Ejemplos de contenido de cómo hacer
-
[AUTOTITLE](/actions/using-workflows/using-starter-workflows)