El contenido de procedimientos ayuda a los usuarios a completar una tarea de principio a fin mientras utilizan GitHub.
Creamos artículos de procedimientos y secciones de procedimientos en artículos más grandes.
Cómo escribir artículos de procedimientos
Para obtener la plantilla de contenido de procedimiento, consulte "Plantillas".
- Sigue las directrices para pasos de procedimientos que se proporcionan en "Guía de estilo".
- El contenido de procedimientos puede ser repetitivo. Busca oportunidades para agrupar el contenido relacionado en un solo artículo más largo.
- Agrupa varios procedimientos relacionados en un solo artículo, a menos que haya un motivo para no hacerlo.
- Si deshabilitar una configuración o deshacer una tarea requiere los mismos pasos y no tiene implicaciones especiales, no escribas un procedimiento aparte.
- Si deshabilitar una configuración o deshacer una tarea requiere pasos diferentes o tiene implicaciones importantes o especiales, crea un artículo más largo que contenga ambos procedimientos. Usa un título genérico.
- Indica a los lectores el resultado esperado del procedimiento.
- Incluye sugerencias de solución de problemas con la mayor frecuencia posible.
Títulos del contenido de procedimientos
- Los artículos de procedimientos o las secciones de procedimientos dentro de artículos se basan en tareas y comienzan con gerundio.
- Usa: "Applying for a student developer pack"
- Usa verbos activos y específicos (haz una lluvia de ideas o usa un diccionario de sinónimos si es 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.
- Longitud del título de un artículo: máximo de 80 caracteres, 60 si es posible.