Como posso documentar melhor essas relações / transformações de dados?

5

Estou trabalhando em um projeto que usa RxJS para realizar transformações de dados em diversas fontes de dados, e estou no processo de escrever alguma documentação para isso.

Eu quero encontrar uma maneira eficaz de documentar o seguinte:

  1. Uma maneira abstrata de descrever a cardinalidade e os relacionamentos dos dados.
  2. Uma descrição abstrata das transformações de dados.

Aqui estão dois exemplos de como estou descrevendo uma transformação de dados. Os cabeçalhos de tabela são os campos de destino, a segunda linha é os dados de origem ou uma transformação feita nos dados de origem para obter os dados desejados.

EupossoverqueoformatodoGithubMarkdownémuitolimitadoparaessepropósito,eéporissoqueestoupedindoajudasobreisso.

EutambémtenhoalgunsdiagramasdeERDqueseparecemcomisso:

Não tenho certeza de uma maneira clara de documentar como as transformações se relacionam com o esquema e quais suposições sobre a cardinalidade são feitas dentro dessas transformações ( getStudentTestScoreDcid em particular)

    
por Nathan Jones 15.01.2016 / 19:17
fonte

1 resposta

7

Os diagramas de fluxo de dados soam como o que você precisa

Da Wikipédia :

A data flow diagram (DFD) is a graphical representation of the "flow" of data through an information system, modelling its process aspects. A DFD is often used as a preliminary step to create an overview of the system, which can later be elaborated.2 DFDs can also be used for the visualization of data processing (structured design).

A DFD shows what kind of information will be input to and output from the system, where the data will come from and go to, and where the data will be stored. It does not show information about the timing of process or information about whether processes will operate in sequence or in parallel (which is shown on a flowchart)

A ênfase acima é minha

O objetivo do DFD é mostrar os aspectos transformacionais dos dados conforme eles se movem pelo sistema. Você sempre terá uma entrada (de um usuário, armazenamento de dados ou outro processo) que alimenta um processo com uma saída (para a tela, armazenamento de dados ou outro processo). Se você não tiver esses três elementos, não o incluirá no DFD. Um outro item que vale a pena mencionar, um grande número (eu diria a maioria) DFDs não tem um ponto de partida ou ponto final no diagrama completo.

Existem pelo menos 2 simbologias diferentes usadas (Gane-Sarson e Yourdon & Coad).

O exemplo abaixo mostra como os dados de um Cliente entram no processo de Ordem de Processo que gera os dados que estão sendo armazenados no armazenamento de dados de Transação. Geralmente, são incluídos armazenamentos de dados duplicados para mostrar o processo com mais facilidade e geralmente são marcados com um símbolo alterado para o armazenamento de dados (um D em uma caixa cinza neste exemplo).

Exemplodo Paradigma visual

    
por 15.01.2016 / 23:33
fonte