Nomenclatura
Nota
Este documento está en progreso. Puede incluir más contenido en futuras iteraciones.
Aviso
La nomenclatura definida en este documento debe aplicarse sin excepción.
Reglas generales
Esta sección contiene reglas generales aplicables toda la nomenclatura definida en este documento.
Escribir todos los nombres en inglés.
Utilizar palabras que describan los nombres de forma clara, concisa y específica.
Evitar nombres largos.
Si el nombre incluye una acción, utilizar verbos en infinitivo seguidos del objeto de dicha acción.
Describir la entidad o contenido de la entidad únicamente y evitar hacer referencia a otras entidades.
Nomenclatura por categorías
La nomenclatura se define por categoría. Cada categoría tiene reglas específicas, con determinadas excepciones. Las categorías incluyen:
App/módulo
Entidades (dentro de las apps o módulos)
Contenido de entidades
App y Módulo
Todos los nombres deben definirse siguiendo estas reglas:
Utilizar la regla de capitalización de PascalCase: todas las palabras empiezan con letra mayúscula.
Separar palabras utilizando guión bajo (_).
Entidades
Todos los nombres deben escribirse siguiendo estas reglas:
Utilizar snake_case: todas las palabras deben escribirse con letras minúsculas y deben dividirse utilizando guiones bajos.
La tabla a continuación describe las entidades en la plataforma Veritran. Aprende cómo nombrarlas y revisa los ejemplos propuestos.
Asset | El nombre se define por la categoría del recurso. Debe incluir la abreviación de la categoría y su identificación. Por ejemplo:
|
Ramas | Ramas release: Agrega un nombre claro. Debe incluir el número de versión a entregar, la fecha de entrega y/o algún alias definido con el cliente. Por ejemplo:
Ramas feature y hotfix: Agrega un nombre claro. Debe incluir el ticket de JIRA asociado a la funcionalidad implementada y un nombre corto y descriptivo. Por ejemplo:
|
Configurable component (creado a través de una interfaz de tipo componente) | El nombre se define por el tipo de componente configurable y su propósito. Por ejemplo:
|
Functional flow (creado a través de una interfaz de tipo pantalla) | El nombre se define por la funcionalidad que representa el flujo funcional. Por ejemplo:
|
Lambda process | El nombre se define por el objetivo del proceso. Por ejemplo:
|
Merge Request | El nombre o título se define por el tipo de cambio (feature, fix, etc), el nombre de la funcionalidad y, si aplica, el número de ticket. Por ejemplo:
|
Screen | El nombre se define por el objetivo de la pantalla.
|
Sequence (en una pantalla) | El nombre contiene la letra S seguido del nombre de la pantalla definida en el campo Name.
|
Theme | El nombre contiene el nombre del proyecto. También puede incluir cualquier característica específica relacionada al tema. Por ejemplo:
|
Transaction | El nombre se define por el propósito de la transacción. Por ejemplo:
|
Contenido de entidades
Todos los nombres deben escribirse siguiendo estas reglas:
Utilizar camelCase: la primera palabra comienza con letra minúscula y el resto de las palabras se capitalizan sin dejar espacios entre palabras.
Las palabras no deben separarse por ningún caracter.
La tabla a continuación describe el contenido de las entidades de la plataforma Veritran. Aprende cómo definir sus nombres y revisa los ejemplos propuestos.
Lambda process variable | El nombre se define por el contenido, no el tipo de variable. Debe incluir información sobre el contexto de la estructura de la información, y, de corresponder, incluir unidades. Por ejemplo:
|
Lambda process function | El nombre se define por el objetivo de la función o la operación que ejecuta, representado por un verbo en infinitivo. Por ejemplo:
|
Lambda process function parameter | Los parámetros permiten que se pase información a las funciones. El nombre se define por la lógica ejecutada por el parametro. Debe comenzar con la letra p en minúscula, para diferenciarlo de una variable.
|
Native component name | El nombre se define por el propósito del componente. Debe comenzar con la abreviación del componente. Por ejemplo:
|
Native component ID | ImportanteEl Name y ID de un componente nativo debe ser el mismo. El nombre se define por el objetivo del componente. Debe comenzar con la abreviatura del componente. Por ejemplo:
|
Input parameter en interfaz de un módulo | Por ejemplo:
|
Output parameter en interfaz de un módulo | Por ejemplo:
|
Input en una transacción | |
Output en una transacción | |
Data (registros y alias) |