El contenido conceptual ayuda a los usuarios a comprender una característica o un tema, porque proporciona información general clara, una explicación de cómo la característica o el tema pueden ayudarles en su recorrido y contexto, como casos de uso o ejemplos.
Creamos artículos conceptuales y secciones conceptuales dentro de otros artículos. La mayoría de los productos, características o temas principales tienen su propio artículo conceptual.
Cómo escribir contenido conceptual
Para obtener la plantilla de contenido conceptual, consulte "Plantillas".
- Describe con un lenguaje sencillo de qué característica, producto o tema se trata.
- Describe su finalidad y por qué es útil para el lector.
- Comparte casos de uso o ejemplos.
- Si es oportuno, describe cómo funciona la característica o el tema (ten en cuenta la audiencia y la ubicación adecuada para profundizar en los detalles técnicos).
- Resalta los detalles que el lector necesita saber para usar la característica.
- Incluye los siguientes pasos para empezar a usar la característica (ya sea con vínculos a otras lecturas o contenido dentro del propio artículo).
Títulos del contenido conceptual
- Los artículos conceptuales o los encabezados de las secciones conceptuales comienzan con "About [tema]".
- Usa un sustantivo para describir el tema.
- Usa: "About code scanning"
- Evita: "About scanning your code for vulnerabilities"
Ejemplos de contenido conceptual
- Artículos conceptuales
- Secciones conceptuales dentro de otros artículos
- "About security policies" en Agregar una política de seguridad a tu repositorio
- "About maintenance mode" en Habilitar y programar el modo de mantenimiento