Guías embebidas (Guías de uso)
Requisitos previos de acceso
- Permiso (módulo):
manageToken— todo el grupo de guías hereda este permiso (requiredModules: [manageToken]en el menú). - Licencia/Feature: Ninguna.
- Contenedor del menú: GENERAL → grupo Guías (ícono "libro")
Qué es / cuándo usar
Las Guías de uso (/usage-guides) son páginas de ayuda estática embebidas en el propio BackOffice. No consumen backend — el contenido es texto internacionalizado (claves usageGuides.* en los archivos i18n). Sirven como referencia rápida dentro de la herramienta para operadores que gestionan la tokenización y los flujos relacionados, complementando (sin reemplazar) este Manual del Operador.
La pantalla tiene dos vistas:
- Cuadrícula (
/usage-guides): tarjetas con todas las guías disponibles. - Detalle (
/usage-guides/:id): abre la guía seleccionada en secciones estructuradas (Visión general, Requisitos previos, Pasos, Consejos, Secciones de pantalla, Botones/Acciones, Campos) y, al final, enlaces rápidos que navegan directamente a la pantalla real correspondiente.
Requisitos previos
- Permiso:
manageTokenen el rol del operador (permiso doble — enum CPM en el backend + módulo dinámico en la base de datos). Sin él, el grupo Guías no aparece en el menú. - Licencia/Feature: Ninguna.
- Dependencias de otras pantallas: Ninguna — es contenido estático. Sin embargo, los "enlaces rápidos" al final de cada guía llevan a pantallas que tienen sus propios permisos/licencias.
Guías disponibles
Son seis guías (cada una es una ruta y un elemento de submenú):
| Guía | Ruta | Foco | Documentación completa en este manual |
|---|---|---|---|
| Tokenización | /usage-guides/tokenization | Visión general del flujo de tokenización (conceptos, requisitos previos, pasos). | Tokenización / páginas de Tokens |
| Gestionar Tokens | /usage-guides/manage-tokens | Crear/editar tokens, cotización, pares de swap. | Gestionar Tokens (grupo Tokenización) |
| NFTs | /usage-guides/nfts | Creación y gestión de NFTs y colecciones. | Gestionar NFTs / Colecciones |
| Crowdfunding | /usage-guides/crowdfunding | Creación de ofertas y órdenes de crowdfunding. | Crowdfunding |
| Distribuciones Financieras | /usage-guides/financial-distributions | Distribuir tokens/valores a los tenedores. | Distribuir Tokens / Pago en Masa |
| Detalles del Usuario | /usage-guides/user-details | Cómo interpretar la pantalla de detalles del usuario. | Detalles del usuario |
Estructura de una guía (vista de detalle)
Cada guía se compone a partir de una lista de secciones tipadas en el componente. Los tipos de sección posibles son:
| Sección | Ícono | Qué aporta |
|---|---|---|
overview | bandera | Visión general / propósito de la funcionalidad. |
prerequisites | checklist | Lo que debe existir previamente (permisos, datos, dependencias). |
steps | lista numerada | Paso a paso de la operación. |
tips | consejo | Buenas prácticas y advertencias. |
sections | diseño | Explicación de las secciones/áreas de la pantalla real. |
buttons | botones | Qué hace cada botón/acción. |
fields | campos | Significado de los campos del formulario. |
Al pie del detalle, el bloque Enlaces rápidos (links) renderiza botones que navegan a las pantallas reales (ej.: la guía de NFTs apunta a /manage-assets).
Acciones y modales
- Abrir guía (tarjeta → "Abrir"): navega a
/usage-guides/:idy cambia a la vista de detalle. - Volver: botón en el encabezado del detalle que regresa a la cuadrícula (
/usage-guides). - Enlaces rápidos: atajos a la pantalla operacional correspondiente. Atención: el atajo no otorga permiso — si el operador no tiene el módulo/licencia de la pantalla de destino, esta no se abrirá con normalidad.
Reglas de negocio / advertencias
Atención
- Contenido estático, sin backend. Las guías no reflejan el estado actual de los datos ni validan nada; son texto de ayuda. En caso de discrepancia entre una guía embebida y el comportamiento real de la pantalla, la pantalla y este Manual del Operador prevalecen.
- Mantenimiento vía i18n. Actualizar una guía implica editar las claves
usageGuides.*enpt-br.json,en.jsonyes.json— todo cambio requiere los tres idiomas (regla de i18n del proyecto). - Visibilidad vinculada a
manageToken. Los operadores sin ese módulo no ven las guías, aunque tengan acceso a las pantallas de destino a través de otros módulos.