Menu de navegação

[YsmaylykaParticipante]

Estou elaborando uma documentação sobre boas práticas na documentação de objetos do banco.
Por favor, alguém poderia me indicar algum artigo, vídeos, livros ou revistas que poderiam está me auxiliando na construção desta documentação?

[José Laurindo ChiappaModerador]

Blz ? Então, na verdade essa é uma área onde simplesmente Não Existem boas prátixas, porque existem N diferentes maneiras de se documentar um database, e cada Empresa, cada DBA, cada Analista, cada Gerente tem a sua visão ….
Tem gente que acha que um MER ou um DER é suficiente, tem gente que prefere um Relatório mesmo mais formal, tem gente que prefere alguma coisa mais interativa (tipo, uma página WEB onde vc tem a lista de objetos, e clicando no nome de cada Objeto vc vê os detalhes…. varia demais…
Pra vc ter uma idéia do que existe pra gerar cada possível tipo de Documentação, veja https://dataedo.com/blog/different-types-of-tools-you-can-use-to-document-your-database …..

Abraços,

Chiappa

[José Laurindo ChiappaModerador]

Só um ponto pra mim é Cristalino : seja qual for o formato de Documentação que vc escolher, vc TEM que :

a) assegurar-se que ele está sendo constantemente alterado/atualizado : é comum vc ver documentação de bancoi linda, maravilhosa, mas que ninguem Atualiza há Anos….

b) não comentar o Óbvio : de repente, na coluna de comentários/explicações do report de objetos duma tabela TAB_NOTA_FISCAL o sujeito escreve : ‘Essa é a tabela de NF’; grande comentário inútil, ne não ?? Documentação desse nível não serve pra porcaria nenhuma

c) é CRUCIAL vc documentar o fluxo dos dados, e a FUNCIONALIDADE de um objeto : pra uma procedure PRC_ATUALIZA_CLIENTE, vc TEM que ter um comentário/informação tipo :

‘Essa procedure é disparada manualmente pelos usuários finais do setor de Vendas, através dum botão na aplicação X, e ela serve para Atualizar o saldo de vendas de cada Cliente Ativo’…

Sacou ??

[]s

Chiappa

[Autor]

Posts