El contenido de introducción proporciona un punto de entrada para usar GitHub productos y características. Esta sección solo debe contener la información esencial mínima que necesita un usuario antes de pasar a conceptos y procedimientos. Lo hacemos para ser breves y, además, para que no parezca complicado empezar con una función.
Consideraciones iniciales
Comenzar es un conjunto de artículos que resultan fáciles y rápidos de consultar. Debe contener menos de 5 artículos y, idealmente, solo dos:
- Inicio rápido
- Acerca de [PRODUCT] (o "What is [PRODUCT]")
La única excepción a esto puede ser con los planes disponibles y la información de facturación, donde dicha información es necesaria para usar el producto o la característica.
Para obtener más información sobre el contenido de inicio rápido, consulte Tipo de contenido de inicio rápido.
En concreto, los artículos con esta información no pertenecen a Introducción:
- Artículos que pertenecen al tipo de contenido de instrucciones.
- Pasos para la configuración o el registro: estas también son guías prácticas. Documentan cómo hacer algo en la interfaz de usuario.
- Contenido útil para empezar a trabajar con una característica determinada, pero no para todo el área de producto. Este tipo de contenido pertenece más correctamente a Conceptos.
- Procedimientos recomendados, por lo general. Los usuarios nuevos en una característica carecen del contexto necesario para sacar el máximo partido a estos.