La página principal debe tener la siguiente estructura:
Estructura
Introducción
Comienza la página con una breve introducción (máximo 2-3 párrafos), explicando qué es, por qué existe y qué problema resuelve.
Usa contexto real para mostrar relevancia.
¿Por qué usarlo?
Destaca los beneficios, diferenciales y casos de uso ideales. Siéntete libre de incluir:
- Mejoras de rendimiento
- Mejoras de seguridad
- Valor de cumplimiento
- Escenarios del mundo real
Conceptos clave
Define los términos, roles o componentes más importantes. Esta sección construye un entendimiento compartido y evita ambigüedades.
Especificaciones técnicas
Documenta los detalles de implementación que los desarrolladores necesitan conocer. Incluye:
- Entorno requerido o dependencias
- Modelos de datos o esquemas
- Reglas de validación internas
- Variables de configuración
Mejores prácticas
Ofrece consejos prácticos para ayudar a los usuarios a usar el producto de manera segura y eficiente. Incluye consejos sobre seguridad, rendimiento y errores comunes.