Creación y actualización de documentación técnica
Pasos anteriores
Para trabajar en la documentación técnica, el líder técnico y el implementador deben haber definido la anatomía y la complejidad de los organismos que deben crearse o actualizarse en el documento Design System en Figma.
¿Quién participa en la instancia de documentación técnica?
El líder técnico y el implementador trabajan en la instancia de documentación técnica.
¿Dónde trabajas?
Para trabajar en este paso, debes utilizar la documentación técnica de componentes configurables disponible para su descarga en Sharepoint.
En este paso, el líder técnico y el implementador deben crear la documentación técnica de cada organismo y especificar cómo se construirá o modificará en Studio.
Los organismos se construyen en Studio mediante el uso de módulos. Los módulos son unidades de construcción en las que cada organismo se crea como un único componente en el editor de pantallas; además, cada organismo tendrá unos parámetros específicos configurados a través de una interfaz, lo que permite que ese organismo pueda luego reutilizarse e instanciarse en diferentes apps.
Para entender cómo completar esta documentación técnica, los miembros del equipo deben comprender el uso de los módulos. Para saber cómo funcionan los módulos, su configuración y cómo crear una instancia de un organismo, lee Módulos.
Ejecución de tareas
Para cada nuevo componente configurable que deba crearse o modificarse, el líder técnico y el implementador ejecutarán las siguientes tareas:
Importante
Cada componente configurable debe tener su propio documento.
Acceder al repositorio de documentación del proyecto en Sharepoint y duplicar la plantilla de documentación técnica.
Importante
Si no puede acceder al archivo, solicitar permiso para verlo.
Cambiar el nombre del archivo para incluir el nombre de la aplicación y el tipo de componente configurable bajo el que se categoriza. Por ejemplo: Veribank-configurable component-indicator.
Importante
Crear un documento por componente configurable.
Completar el archivo utilizando la plantilla. La plantilla incluye información sobre cómo crear el componente configurable como interfaz en el módulo de proyecto, y la configuración y finalidad de los parámetros de entrada, salida, mensaje y evento. Si tienes que actualizar la documentación de un componente configurable existente, realiza los cambios en el archivo del componente correspondiente. Consulta Convenciones de nomenclatura para saber cómo definir los nombres de cada componente configurable.
Añadir el enlace del documento a la sección de componentes configurables en Sistema de Diseño del repositorio de proyectos.
Importante
Esta documentación es obligatoria y será utilizada por: los implementadores, cuando construyan el organismo en Studio; y los usuarios de Veritran, cuando instancien el organismo y necesiten entender el propósito de sus parámetros y cómo configurarlos en el editor de pantallas.
Convenciones de nomenclatura
Nombre de la interfaz: El nombre debe incluir la abreviatura del tipo de componente configurable y el nombre del componente, utilizando letras mayúsculas y cada palabra debe estar separada por guiones bajos. Por ejemplo: IPT_PHONE_NUMBER
Parámetros de entrada/salida: El nombre debe escribirse en mayúsculas y debe ser descriptivo.
Parámetros de eventos/mensajes: El nombre debe escribirse en mayúsculas y cada palabra debe ir separada por guiones bajos (si aplica). Por ejemplo: ONCLICK
Restricciones técnicas
A la hora de definir la configuración del organismo, el líder técnico y el implementador deben tener en cuenta las restricciones que se enumeran a continuación. Estas son obligatorias y los organismos no podrán construirse si no se cumple alguno de los siguientes requisitos.
El componente configurable no puede invocar una transacción o una call API.
El componente configurable debe resolver su propia lógica.
La estructura del componente configurable no incluye ni invoca a ningún otro organismo, salvo en el caso de las listas.
El componente configurable no puede utilizar variables locales para resolver la lógica interna del módulo a través del cual fue construido.
Nota
Las variables locales son específicas de una aplicación. Los organismos sólo pueden utilizar variables globales.
Si se requiere un dato de variable global, debe configurarse en el parámetro de entrada de la interfaz creada para el componente configurable.
No debe utilizarse un JSON como datos dinámicos para los parámetros de entrada.