Telescope (core)

Padronização de nomes dos elementos que compõe um sistema

ADS.FAQ-82929
O nome do sistema deve ser um código curto que identifica um conjunto de elementos destinados a resolver um determinado problema.

No Telescope, utilizamos os seguintes critérios para identificar, definir e nomear um sistema.

Sistema BASE

Quando desenvolvemos um sistema que será o produto final que será instalado e implantado, chamamos de sistema BASE o de maior escopo. Normalmente, o sistema BASE serve apenas como um "Guarda-chuva" que combina um conjunto de sub-sistemas que focam as diferentes áreas relacionadas ao que está sendo desenvolvido.

Ex:

Sub-sistema CORE

Um sistema CORE é um sistema que resolve uma questão específica e genérica. Estes sistema possuem entidades, interfaces genéricas e de configuração. Não devem incluir interfaces para cenários/segmentos específicos. Um sistema CORE deve depender apenas de outros sistemas CORE. Não deve depender de um sistema CRUST.

Ex:

Sub-sistema CRUST

Um sistema CRUST corresponde a um sistema que atende a um cenário específico. Estes sistema não devem possuir entidades. Devem ser composto única e exclusivamente por blocos de interface. Os sistemas CRUST podem depender de sistemas CRUST ou CORE.

Ex:

Entidades

Nome

O nome das entidade deve ser um SUBSTANTIVO no PLURAL. Quando for necessário nomes compostos NÃO deve conter elementos de ligação como DE, DO, PARA, etc.

Atributo

Os atributos devem ser substantivos ou adjetivos. Na maioria das vezes estarão no SINGULAR, mas em alguns casos, podem ser usados no plural.
Exemplos:

Blocos de interface

Nome


Operações de um bloco (features/telas)

Nome

Pode ser um dos nomes convencionados para as operações padrão: SEARCH, QUERY, LIST, VIEW, INSERT, UPDATE, DELETE, SHEET, REPORT, IMPORT, EXPORT ou PIVOT.
Para operações tipo CUSTOM, CUSTOM_ACTION ou RECORD_ACTION, o nome da operação deverá obrigatoriamente ser um VERBO. Ex: EMITIR, CANCELAR, VALIDAR, etc.

Preferências

Deve ser um SUBSTANTIVO no SINGULAR.