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 de conceptos y secciones conceptuales en otros artículos. La mayoría de los productos, características o temas principales tienen su propio artículo de conceptos.
Decidir entre un artículo o una sección
Las guías prácticas o los tutoriales pueden incluir entre 1 y 2 breves frases introductorias antes de los pasos. Si se necesita más explicación más allá de un par de oraciones, es cuando deberíamos considerar si merece un lugar en un artículo de conceptos.
Sin embargo, debemos ser selectivos. No todos los conceptos o la sección "Acerca de X" necesitan su propio artículo. Por lo general, esto se reduce a la cantidad de información que será útil para el usuario que necesitamos incluir.
Cómo escribir contenido conceptual
Para obtener la plantilla de contenido conceptual, consulta 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.
Títulos para contenido conceptual
Los títulos cortos de los artículos deben ser una palabra o una frase de nombre. Si los artículos aparecen en Conceptos en la barra lateral, evite usar "Acerca", a menos que el artículo aparezca bajo un encabezado del mismo nombre. Por ejemplo: "Agente de codificación" y "Acerca del agente de codificación".
Los encabezados de las secciones conceptuales de los artículos comienzan por "Acerca de [asunto]".
- Usa un sustantivo para describir el tema.
- Use: "Acerca de code scanning"
- Evita: "Acerca de escanear tu código en busca de vulnerabilidades"
Ejemplos de contenido conceptual
- Artículos conceptuales
- Secciones conceptuales dentro de otros artículos
- Sobre políticas de seguridad en Agregar una política de seguridad a tu repositorio
- "Acerca del modo de mantenimiento" en Habilitar y programar el modo de mantenimiento