PrayTeam / scriptured-prayer

GNU Affero General Public License v3.0
1 stars 0 forks source link

Define Our Terms #12

Closed Soyokaze-42 closed 6 months ago

Soyokaze-42 commented 6 months ago

I've noticed quite a bit of ambiguity in the terms we are using to describe the app. It would help us to define our terms and strictly use them in our discussions. Let's use this issue to hash out the initial set of terms we are going to use to describe these things. Please add terms in the comments below that are up for discussion, discuss them, and propose changes to the terms here in the issue description so we can get on the same page. Once we have consensus, we will add these to the README.

Terms:

Concept-Only Terms:

Soyokaze-42 commented 6 months ago

Unless we need to keep or use information about the category (other than the title), Category Deck will not be in the database. It can be, but it isn't right now.

kenancasey commented 6 months ago

I don't like the word page in the definition of a Prayer Box. I thought we were defining data schema/conceptual structures, not UI. Can we reword that Prayer Box definition to decouple it from the UI?

kenancasey commented 6 months ago

To be clear, I'm for having a shared vocabulary for key concepts to aid communication.

Soyokaze-42 commented 6 months ago

There are two UI components in there - I totally agree that we should segregate. Category Deck and Prayer Box are both not schema things. I moved them in the description - what do you think?

I also did not define all the schema terms. Do you think this should be comprehensive for the schema? I was going for the ones that matter for our issues. We get better readability at the expense of the chance of leaving something important out.

benjoeclark commented 6 months ago

I have tried a Figma Mock-up with this naming convention. https://www.figma.com/file/lpfV0Ony7djEKA8XkpAoD7/Mock-up?type=design&node-id=0%3A1&mode=design&t=TsTVg8FTgAd1gAox-1

Soyokaze-42 commented 6 months ago

Kenan and I were talking about the PrayerDeck. I was thinking we would have multiple PrayerDecks and consider one deck a prayer, but it is simpler to think of the PrayerDeck as the current deck of cards being prayed. There will only ever be one per user. Instead of counting PrayerDecks (the way I was thinking, this would be the number of prayers facilitated), we can instead use the UserCards prayed as the metric for user progress for the site. It gets us out of determining if a PrayerDeck is finished or not as far as tracking metrics go. I'm adjusting the definition above, but more discussion is welcome!