seedcase-project / design

Overall architectural design documentation for Seedcase software.
https://design.seedcase-project.org
Creative Commons Attribution 4.0 International
0 stars 0 forks source link

Generally: Mentions of "Seedcase", "Seedcase Project", "Seedcase the software product", "Seedcase Data Resource", etc. #21

Closed signekb closed 1 month ago

signekb commented 10 months ago

Apologies for this becoming such a long issue :-)

Throughout the texts, there are (naturally) mentions of Seedcase. However, as a reader, it can be quite confusing to understand what is meant when there's referred to different parts of "Seedcase" .

I think that being more precise with what we call the different parts of Seedcase (the entire project), this might really help clarify what is meant throughout almost the entire documentation :-)

It seems that there are (at least) three parts of Seedcase that are described in various way across the documentations:

For me, it gets particularly confusing, with mentions of "Seedcase" or "the Seedcase", because it seems which parts that is differs across the texts. For example:

On top of this, I'm a bit confused about the "data components" vs "software" of seedcase mentioned in design/software-architecture/introduction: https://github.com/seedcase-project/seedcase-project/blob/d6086fe2ca077597dc7cf00db9d863055f04139e/design/software-architecture/introduction.qmd#L64-L65

as well as the "framework": Is that the entire "Seedcase Project"?

Idea: We could implement when users hover their mouse over the different parts, their definitions would come up?


In the following, I have found some specific examples of different words used for the same thing:

The "Seedcase Software Product":

"Seedcase Data Resource":

martonvago commented 1 month ago

I've been looking into this and ran into some questions:

I'm mainly asking because it wouldn't make sense to reword all of the docs to make them talk about a plurality of products, but it is confusing that some docs imply that there is a single product, while others imply that there are multiple.

(@lwjohnst86 or @seedcase-project/developers :slightly_smiling_face: )