I'm working on a project that uses
RxJS to perform data transformations on varying sources of data, and I'm in the process of writing some documentation for it.
I want to find an effective way to document the following:
- An abstract way to describe the cardinality and relationships of the data.
- An abstract description of the data transformations.
Here are two examples of how I'm describing a data transformation. Table headers are the destination fields, the second row is the source data or a transformation done on the source data to get the desired data.
I can see that the Github Markdown format is very limited for this purpose, which is why I'm asking for help on this.
I also have a few ERD diagrams that looks like this:
I'm not sure of a clean way to document how the transformations relate to the schema, and what assumptions about cardinality are made within those transformations (
getStudentTestScoreDcid in particular)