Dicas para dicionarização de elementos em um modelo de dados

1.Introdução

A representação gráfica e denominação dos elementos que compõem um modelo de dados, de forma geral, não são suficientes para traduzir todos os conceitos envolvidos e que são necessários para caracterizá-los, interpretá-los, defini-los e compreendê-los de forma evidente, tanto para o responsável por sua criação, quanto para qualquer leigo em relação ao ambiente modelado que se interesse em conhecê-lo.

Para alcançar tal propósito, faz-se necessário tomar medidas que evitem ambiguidade nas interpretações desses elementos e permitam esclarecê-los por completo. A dicionarização dos elementos dos modelos é um instrumento essencial que possibilita dotá-los de informações que atendam tais requisitos.

A dicionarização dos elementos é considerada como parte fundamental do processo de modelagem já que por seu intermédio, além dos benefícios citados em relação à leitura do modelo, abrem-se possibilidades de disseminação do conhecimento relativo aos negócios corporativos representados pelos diagramas de negócio e modelos de dados. Além disso, tal prática permite que se realizem levantamentos de similaridades entre objetos de modelos diversos possibilitando a reutilização dos mesmos.

2.Nomeação de entidades, atributos e relacionamentos

Todo e qualquer objeto (entidade ou atributo) deve ser nomeado através de uma identificação unívoca. Seguem abaixo dicas de como nomear estes objetos:

• O nome do objeto deve representar o negócio de forma a não haver dúvidas quanto a sua especificação.
• O nome do objeto deve ser nomeado com o seu real significado dentro da organização, com uma visão corporativa, não somente dentro do cenário do sistema no qual está sendo modelado.
• O nome do objeto deve ser qualificado para que o seu significado seja claro e absoluto. Devemos evitar a utilização de nomes muito genéricos para a denominação de um objeto.

Exemplo: Uma entidade denominada como “ESPECIALIDADE” possui significados diferentes dependendo da sua área de aplicação. Se utilizarmos nomes mais qualificados como: “ESPECIALIDADE_MEDICA" e “ESPECIALIDADE_FORNECEDOR” não teríamos duas entidades com o mesmo nome, porém com significados diferentes.

• Todo objeto deve ser nomeado quanto ao número no singular, tendo em vista que o significado de seu nome qualifica uma única ocorrência de objeto conceitual por vez.
• Sempre que possível opte por um gênero default (masculino ou feminino) para fins de padronização.
• Nomes ou siglas departamentais de uma organização devem ser evitados sempre que possível, à exceção de siglas ou abreviaturas já consagradas no meio corporativo.
• Utilize verbos no particípio quando a qualificação do nome se referir a uma ação ocorrida.

Exemplo:“VL_PARCELA_RECOLHER” (Incorreto) – “VL_PARCELA_RECOLHIDA” (Correto)

• Evite o uso de preposições, artigos e conjunções irrelevantes para o significado do objeto.

Exemplo:“TIPO_DE_CLIENTE” (Incorreto) – “TIPO_CLIENTE” (Correto).

• Evite utilizar algarismos na nomeação do objeto

Exemplo: “DT_2_CHAMADA” (Incorreto) – “DT_SEGUNDA_CHAMADA” (Correto)

Nomeação de relacionamentos

• A estrutura de identificação nominal para Relacionamentos deve ser composta de um verbo ou locução verbal que defina a relação existente entre os objetos, preferencialmente, conjugada na 3ª pessoa do singular do presente do indicativo.
• Havendo necessidade de nomear o relacionamento nos dois sentidos, utilize a voz passiva do verbo que define a ação para um dos sentidos ou outro verbo, que seja equivalente, conjugado na 3ª pessoa do singular do presente do indicativo.
• Dê preferência a verbos de ligação (ser, estar, permanecer, etc.), evitando verbos como existir, ter e possuir. Esteja sempre atento ao sentido e à semântica do relacionamento, para que expresse corretamente a regra de negócio.
• Os auto-relacionamentos devem ser nomeados obrigatoriamente nos dois sentidos. Geralmente, relacionamentos do tipo "um para muitos" possuem a finalidade de representar estruturas do tipo "hierarquia" (Pai x filho por exemplo). Já os auto-relacionamentos do tipo "muitos para muitos" geralmente possuem um sentido de "composição" , "constituição".

3.Conceituação de entidades e atributos

Toda e qualquer objeto deve ser conceituada através de uma definição unívoca ou declaração de propósitos, que esteja em conformidade com um conjunto de regras pré-definidas. Seguem abaixo dicas de como conceituar estes objetos:

• A definição deve explanar o que o objeto é (conceito) em sua essência e com relação ao escopo em análise. Não se deve simplesmente copiar o que está no dicionário ou qualquer outro texto descritivo que referencie o conceito fora do contexto do negócio.
• A definição do objeto deve ser clara, completa e objetiva, propiciando a compreensão consistente do objeto e do seu valor para o negócio. Em outras palavras, o que o objeto está fazendo no modelo do negócio?
• Deve ser escrita em linguagem não técnica e usando, preferencialmente, a língua portuguesa. Quando inevitável, termos e expressões em idioma estrangeiro devem ser acompanhados das respectivas traduções.
• A definição do objeto deve ser elaborada com base na terminologia do negócio, mas sempre buscando ser compreensível para o leitor leigo ou não especializado.
• A definição deve considerar o objeto e seus possíveis papéis no negócio. Cada papel deve ser descrito obedecendo aos requisitos estabelecidos acima.
• Mesmo sendo o objeto referenciado a múltiplas funções, processos, áreas da organização e visões particulares dos sistemas, ainda assim, deverá possuir o seu conceito sempre estável. Caso haja definições particulares, que restrinjam ou ampliem o conceito definido, devem estar explicitadas em especializações ou generalizações que descrevam cada uma dessas visões, deixando claro a qual delas pertence.
• Todo objeto com características de classificação ou agrupamento (Tipo, Classificação, Grupo, etc) opera segundo (em função de) uma ou mais propriedades do objeto que está sendo classificado / agrupado. Sua definição, portanto, deve explicitar a(s) propriedade(s) em que se baseia a classificação.
• Para atributos, sua definição deve definir que característica(s) confere à entidade.
• A definição do atributo deve deixar claro o papel ou papéis que o mesmo representa como qualificador da Entidade.
• A definição do atributo deve conter exemplos para clarificação do conceito. Quando aplicável, especialmente no caso de indicadores, a definição deve explicitar o domínio discreto que o atributo pode conter. Exemplo: Para o atributo IN_TIPO_PESSOA, poderíamos ter as ocorrências: "F" para Pessoa Física e "J" para Pessoa Jurídica.

O que deve ser evitado na definição de Entidades e Atributos:

• Definição tautológica. Uma definição não deve conter o nome do objeto antes que o mesmo tenha sido previamente definido. Por exemplo, se ao definir a entidade "Cliente", a descrevermos como sendo: “todo cliente que...”, estamos dizendo o que um cliente faz e não o que um cliente é (seu conceito). Melhor seria algo como: “pessoa física ou jurídica a qual adquiriu...”.
• Definição com termos desnecessários. Por exemplo, a expressão “trata-se do conjunto de informações sobre toda e qualquer...” aplica-se à definição de toda e qualquer entidade e não apenas a entidade específica. Por não acrescentar significado relevante, torna-se desnecessária, já que, por definição, todo elemento de um conjunto de objetos compartilha todas as propriedades do conjunto. Da mesma forma, deve-se evitar o uso de expressões como “Esta entidade tem a finalidade de ...” ou "Esta entidade foi criada devido........".
• Frases muito longas. Em benefício da facilidade de compreensão, uma definição não deve usar períodos de texto muito longos. Um parágrafo composto de frases curtas, mais objetivas, pode aumentar significamente a clareza da definição.
• Formas de utilização e acesso. Descrição de onde, quando, como e por quem o objeto é utilizado. Isto se aplica mais a matrizes de processos x dados.
• Definições com o caráter exclusivamente físico. Referenciar o objeto como um meio de armazenamento, como, por exemplo: tabela, repositório, etc.
• Exemplos de boas definições

BOLETO_COBRANCA: Guia de pagamento representativo de um valor a receber emitido a um sacado para a quitação de um bem ou serviço. O boleto de cobrança deve ser quitado na rede bancária. Atributos da entidade:

NR_COBRANCA: Identificador numérico automaticamente atribuído à correspondência eletrônica dirigida a uma Empresa, informando-a do evento de cobrança.

DT_VENCIMENTO: Dia, mês e ano limites para que o pagamento do valor cobrado seja efetivado pelo devedor.

VL_COBRANCA: Importância cobrada mensalmente a organização a título de prestação de serviços. Este valor é reajustado semestralmente.

DT_PAGAMENTO: Dia, mês e anoem que foi efetuada a quitação de uma cobrança.

VL_MULTA_ATRASO: Importância cobrada uma única vez ao devedor inadimplente, a título punitivo, pela quebra de expectativa de receita por parte do credor. Esta importância é fixada contratualmente, podendo ser um percentual do valor originalmente cobrado ou uma quantia fixa.

CONTRATO_CONCESSAO: Documento que oficializa um acordo entre duas ou mais partes (pessoas) que se sujeitam a cumprir as obrigações estabelecidas em um contrato judicial devido à utilização de bens públicos, ou de exploração de recursos naturais (jazidas, energia hidráulica) pertencentes à União.

ESPECIALIDADE_MEDICA: Classificação dada pela OMS (Organização Mundial de Saúde) para distinguir os ramos e especializações em que um referenciado possa ter condições de atuar. Em casos específicos, uma Especialidade pode ser dividida em várias sub-especialidades. Exemplos de Especialidades: Cardiologia, Cardiologia Pediátrica, Cirurgia Cardiovascular, Clinica Geral, Ortopedia, Pediatria, etc.