Ferramenta de apoio ao desenvolvimento de Diagramas de Entidade e Relacionamento por meio de texto

Esse projeto consiste em um instalador e um documento para auxiliar na utilização de uma extensão do VSCode para criação de Diagramas de Entidade e Relacionamento por meio de texto, com o objetivo de facilitar a criação de diagramas para pessoas com deficiência visual.


Sumário

Instalação

  1. Download do instalador
  2. Execute o arquivo instalador.exe
  3. Aguarde a instalação. O Windows pode solicitar uma confirmação para a instalação.

O NVDA (Non Visual Desktop Access), “Acesso Não-Visual ao Ambiente de Trabalho”, é um leitor de tela criado com intuito de facilitar o acesso de deficientes visuais a esta tecnologia. O leitor de tela NVDA possibilita que estas pessoas realizem diversas atividades no computador de forma autônoma, como por exemplo: Navegar por páginas do computador; ler e escrever textos; edição e criação de pastas; acessar comando no Windows para ações através de atalhos e realizar atividades mais complexas como formatação do computador.

Configuração do NVDA

Para realização da leitura de tela é necessario a troca da linguagem padrão para a voz "leticia" que consegue identificar pontuações dentro do VsCode.

Para adicionar a voz da Letícia, faça o download através do link aqui. Após o download, instale.

Para mais informaçoes sobre a voz da Letícia acesse aqui.

Para configurar a voz, vá em “divisa de notificação botão” no canto inferior direito da barra de tarefa do Windows, aperte no “NVDA botão”, siga até “preferências menu”, em seguida “configurações”.

Na tela que será aberta "configurações do NVDA: Geral (configuração normal)”, em categorias vá em Fala 2 de 13, na seção voz (caixa de combinação) escolha “Leticia - F123”.

Ainda na mesma seção de voz em “Grau de pontuação/símbolos" selecione a opção “tudo”, para que o software possa ler todas pontuações e símbolos no código.

Clique em “Aplicar” e “OK” no canto inferior direito do NVDA.

Instruções de uso

  1. No VSCode, criar um arquivo com a extensão .er
  2. Para abrir a visualização, pressione F1 para abrir a pesquisa do VSCode e busque por "ERD: Preview Current Window"

Como modelar um diagrama ER

Entidades

As entidades são declaradas dentro de colchetes []. Por exemplo, é assim que declara a entidade Pessoa sem atributos: 
        [Pessoa]


Nomes e atributos de entidades podem conter espaços se citados com acentos graves, aspas simples ou duplas: 
        [`Pessoa Física`]
        ['Pessoa Física']
        ["Pessoa Física"]

Atributos

Um atributo pode ser declarado logo abaixo da entidade a que pertence. Por exemplo, é assim que declara o atributo nome para a entidade Pessoa: 
        [Pessoa]
        nome

Qualquer número de atributos pode ser declarado como uma chave primária para sua entidade prefixando o atributo com um *. Da mesma forma, um atributo pode ser declarado como uma chave estrangeira prefixando o atributo com um +: 
        [Pessoa]
        *id
        +endereco_id

Relacionamento de Entidades

Os relacionamentos também podem ser declarados em qualquer lugar em um arquivo ER. Todo relacionamento inclui exatamente duas entidades (as duas entidades podem ser as mesmas, para auto-relacionamentos). Cada entidade em um relacionamento deve ter exatamente uma das quatro cardinalidades:
Cardinalidade Sintaxe
0 ou 1 ?
exatamente 1 1
0 ou mais *
1 ou mais +

Assim, por exemplo, o seguinte define uma relação entre Pessoa e Endereço que diz "cada pessoa tem exatamente um endereço": 
        Pessoa *--1 Endereço

Atividade - Modelo Entidade Relacionamento

A seguir serão apresentadas duas situações, uma sobre a organização de CDs e a outra sobre uma transportadora de mercadorias. Essas situações são parecidas com uma atividade da sua professora de banco de dados. Você deve montar o diagrama de entidade relacionamento dessas situações utilizando a nova linguagem que você aprendeu. Você pode consultar o material que explica a linguagem durante a execução do exercício.

Situação 1 - Organização de CDs

Uma aluna de computação deseja organizar seus CDs. A seguir estão listadas as características desses CDs e suas músicas:

Situação 2 - Transporte de mercadorias

Um cliente deseja enviar alguma mercadoria/produto para alguém através da transportadora. O processo na transportadora funciona da seguinte forma: a transportadora registra uma coleta de mercadoria no banco de dados. Os dados da coleta contém o remetente, que é a pessoa que envia a mercadoria, e o destinatário, que irá receber a mercadoria. Ambos são clientes. Remetente e destinatário tem nome, CPF/CNPJ, telefone, endereço (seja para cobrança do frete ou entrega da mercadoria), cidade e estado. Além dos dados do cliente, também são registrados na coleta, a mercadoria a ser coletada, seu valor, peso e tamanho (metros cúbicos), além do pagador do frete (que será o remetente ou destinatário).

Possíveis problemas e soluções

Erro na instalação do Graphviz

  1. Verifique se o Graphviz foi instalado digitando no terminal "dot --version"
  2. Caso não seja encontrado, instale manualmente a partir do link: https://www.graphviz.org/download/
  3. Atualize o arquivo settings.json do VSCode com o caminho correto para a chave: "erd-preview.dotPath"

Erro na instalação do ERD

  1. Verifique se o ERD foi instalado digitando no terminal "erd --version"
  2. Caso não seja encontrado, faça o download do seguinte repositório para a pasta do instalador: https://github.com/BurntSushi/erd
  3. Pelo terminal, acesse a pasta do instalador. Há um arquivo chamado stack.exe
  4. Acesse a pasta do repositório e rode o comando: "caminho/para/o/stack.exe install --compile=ghc-8.8.4 --resolver=lts-16.8"
  5. Atualize o arquivo settings.json do VSCode com o caminho correto para a chave: "erd-preview.erdPath"

Referências

As seguintes referências foram utilizadas como base para esse trabalho. Em caso de algum repositório abaixo estar descontinuado, há uma cópia dos projetos na base desse material.

https://github.com/BurntSushi/erd
https://github.com/kaishuu0123/vscode-erd

Sobre o trabalho

Este trabalho foi desenvolvido como atividade de extensão para a disciplina de Acessibilidade e Inclusão Digital ministrada na UTFPR, câmpus Curitiba no primeiro semestre de 2023.

Autores

Coordenador

Leonelo Dell Anhol Almeida


Licença Creative Commons
Este obra está licenciado com uma Licença Creative Commons Atribuição 4.0 Internacional.