perfil-politico icon indicating copy to clipboard operation
perfil-politico copied to clipboard

Published 20 hours ago • verified publisher icon okfn-brasil

Add an Entity Relationship Diagram (ERD) in the readme.md

Open gabriel19913 opened this issue 4 years ago • 2 comments

I think would be nice to add an ERD in the readme.md. This will make easier to see how the data are relationed in the database, also it makes easier to know what data is available in the API.

gabriel19913 avatar Aug 30 '20 00:08 gabriel19913

I agree. I can do that.

I was just wondering if the readme.md file can get a little polluted since one of the tables has a large number of columns. I thought of creating a short version of the ER (with only the entities' names and relationships) and a second more detailed version in a different file. This second file could even have a data dictionary. Does this make sense?

mmondelli avatar Sep 02 '20 21:09 mmondelli

Hi @mmondelli I agree with you. Usually I add the ERD in the readme of my projects, but really it can make the readme a little bit polluted in this project. So I think you can do in this way. Thanks.

gabriel19913 avatar Sep 02 '20 22:09 gabriel19913