search

JacquesCarette / Drasil

Generate all the things (focusing on research software)
https://jacquescarette.github.io/Drasil
BSD 2-Clause "Simplified" License
140 stars 26 forks source link

Documenting program families #1941

Open bmaclach opened 5 years ago

bmaclach commented 5 years ago

As we add more design choices, we will need to decide on a way to document the available choices and dependencies between them.

This issue based on discussion in #1862 starting from https://github.com/JacquesCarette/Drasil/issues/1862#issuecomment-542713288.

bmaclach commented 5 years ago

Another dependency between design choices is that Doxygen output verbosity only matters if comments are turned on.

I wonder how closely this issue is related to #1861? Surely any taxonomy we develop for the design choices would reflect the dependencies between choices. Could it be that the result of #1861 can solve this issue as well, i.e. the design choice "language" could act as the documentation of the program families?

JacquesCarette commented 5 years ago

We might want to look at 'feature diagrams' and 'feature algebra' for modeling simpler dependencies. Yes, this is definitely related to the taxonomy, which will be structured.