Acerca de los temas

Los temas se usan para filtrar artículos y admiten búsquedas en el sitio de GitHub Docs. Para algunos diseños, como páginas de aterrizaje o guías, los usuarios pueden seleccionar qué artículos se muestran filtrando los temas. Usa estas directrices para ayudar a elegir los temas que se agregan al texto preliminar de un artículo. Para obtener más información sobre cómo agregar temas a un artículo, consulta "Temas". Para obtener una lista de todos los temas permitidos, consulta allowed-topics.

Temas para todos los tipos de contenido

• Todos los artículos deben tener al menos un tema.
• Usa nombres como temas.
• Los temas ayudan a los usuarios a agrupar contenido de forma significativa.
  • Cuando sea posible, usa temas más específicos que sean relevantes, no solo temas amplios. Por ejemplo, REST o GraphQL en lugar de solo API.
  • Asegúrate de que los temas de artículos similares sean coherentes para que los usuarios que filtren por un tema obtengan todos los artículos pertinentes. Por ejemplo, todos los artículos sobre CI deben tener el tema CI y temas más específicos.
  • Evita temas ambiguos. Por ejemplo, Actions puede que no sea un tema útil dentro del producto Actions, ya que podría hacer referencia al producto GitHub Actions o al elemento del producto denominado acción.
• Los temas agregan valor (no replican) más allá del título, el tipo o la categoría del artículo.
  • Por ejemplo, dentro del producto Actions, Actions no agrega ningún valor, porque alguien que esté en esta sección de la documentación ya sabe que está consultando la documentación de Actions.
• Usa Fundamentals para artículos relacionados con los conceptos básicos de un área de producto.
  • Usa Fundamentals en un artículo como "Introduction to GitHub Actions".
  • Evita Actions en un artículo como "Introduction to GitHub Actions".
• Se pueden usar abreviaturas reconocidas habitualmente, pero deben evitarse las abreviaturas poco conocidas o ambiguas.
  • Usa CI en lugar de Continuous integration.
  • Evita el uso de AS en lugar de Advanced Security.
• Usa los formatos cortos de los nombres de producto de GitHub.
  • Usa Actions en lugar de GitHub Actions.

Lista de comprobación para la elección de temas

Usa estas preguntas para ayudarte a elegir temas para un artículo. No todos los artículos tendrán un tema para cada elemento de la lista de comprobación.

• ¿Cuál es la característica o el área del producto?
  • Ejemplo: Enterprise. ¿El artículo es sobre una subcaracterística? (a menos que el nombre del producto coincida con el nombre de la característica)
  • Ejemplo: Dependabot
• ¿La característica forma parte de un programa restringido?
  • Ejemplo: Advanced Security
• ¿Sobre qué elemento de la característica o del producto es el artículo?
  • Ejemplo: Organizations
• ¿Cuál es la finalidad general del artículo?
  • Ejemplo: Permissions
• ¿Qué lenguajes de programación, administradores de paquetes o ecosistemas aborda explícitamente el artículo? Incluye estos temas únicamente si agregan valor a alguien que filtre los documentos, no solo porque un artículo enumera los lenguajes, administradores de paquetes o ecosistemas admitidos.
  • Ejemplo: Ruby