![]() ![]() To easily read the information from the RST files, I recommend using DocUtils to generate an XML version of the source file. Now that we have a base document, we can try to generate diagrams of it. :`Group`_: A user can be part of one group.īecause we are using the reference notation again, we can already click link to navigate to the different relations. Now that we use references (the User_ format), we can take it one step further and start listing the relations of the entities: ![]() If your document gets quite large, the link can be very handy:Ī group of User_ entities can have specific roles in the application. Using this format, we can add a lot of background information and annotations, while keeping a structured format we can use later.Ī lot of viewers ( GitHub included) can present the reStructuredText quite good already, including references in the document. :username: The username a user will use to login to his/her accountĪ group of users can have specific roles in the application. This file is used to describe all entities, their properties and how they relate. Those text files evolved to MarkDown files, and recently I started using reStuctured text (.rst) files, because it is a very powerfull format (and it has a lot of parsers, which will help me achieve my goals I stated in the beginning of this blog post). Next to Visio, Google Draw, Omnigraffle, etc… there are new players like Skipper, that can be used to easily generate Doctrine models, but these are still a bit to limited for me.īecause I like to be verbose in decisions I make when designing models and how they fit together, I usually start with a basic text file listing entities and there properties. The reasons for this is that I don’t want to bind myself to a specific program, that I want to be able to use the data in different places/formats, and most importantly that I can version control it (and diff it as text). Recently I had to create an ERD for a project, and I didn’t wanted to use a binary (and mostly a proprietary) format. ![]()
0 Comments
Leave a Reply. |