Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

model.md and implementation-notes.md #83

Open
chrisklus opened this issue Dec 13, 2021 · 6 comments
Open

model.md and implementation-notes.md #83

chrisklus opened this issue Dec 13, 2021 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation status:blocks-sim-publication

Comments

@chrisklus
Copy link
Contributor

From #75 (@Luisav1 and I are working on this part together)

We will write a first draft of model.md and implementation-notes.md, likely just for the Game, and then I'll come back in the future to finish them for the whole sim.

Luisav1 added a commit that referenced this issue Dec 14, 2021
…eedback from model.md to implementation-notes.md. See #83.
@Luisav1
Copy link
Contributor

Luisav1 commented Dec 14, 2021

@pixelzoom We completed a first draft of these for the game screen, let us know what you think. We also used your sims as an example, let us know if we copied too much of your style.

pixelzoom added a commit that referenced this issue Dec 14, 2021
@pixelzoom
Copy link
Contributor

pixelzoom commented Dec 14, 2021

model.md looks really great! model.md is typically a high-level description, suitable for teachers and other non-developers, and this does the job. Some feedback:

(1) Since the level-selection buttons are not labeled or numbered, it wasn't clear to me which buttons were 'Counting' vs 'Subitize', or 'Level 1' vs 'Level 2'. If figured it out after playing with the game. You might want to clarify this in the document, something like "On the level-selection (Choose You Game!) interface, Counting games are the top row of buttons, Subitize games are the bottom row of buttons. Level 1 is the left column of buttons, Level 2 is the right column of buttons."

(2) I made one minor language change, changing "wrong" to "incorrect". "Wrong" tends to come with moral baggage, so "incorrect" is typically more appropriate in a learning context. Do a Google search for "wrong vs incorrect" if you'd like to read more.

(3) If you haven't already, have the sim desiginer (@amanda-phet?) review and sign off on model.md.

implementation-notes.md looks a little sparse, but I can't say for sure until I dig into the code. So I'll leave this self-assigned, and circle back with more feedback.

@pixelzoom
Copy link
Contributor

pixelzoom commented Dec 14, 2021

(1) Since the level-selection buttons are not labeled or numbered, it wasn't clear to me which buttons were 'Counting' vs 'Subitize', or 'Level 1' vs 'Level 2'.

Oh, I see (light bulb goes on). The "1" and "2" on cards are the level numbers for the Counting game levels -- I missed that, thought they were just numbered cards like I'd seen in other screens. And the number of dots indicate the level numbers for the Subitize game levels.

I still think it's worth explaining in model.md.

pixelzoom added a commit that referenced this issue Dec 15, 2021
@pixelzoom
Copy link
Contributor

pixelzoom commented Dec 15, 2021

implementation-notes.md looks a little sparse, but I can't say for sure until I dig into the code. So I'll leave this self-assigned, and circle back with more feedback.

implementation-notes.md still feels sparse, and I didn't find it to be very useful in this review. I identifed some required information in #87 and #88, so that should flesh things out a bit. It would also be useful to identify patterns used, like #96.

Other than that, the best thing might be to flesh out implementation-notes.md in the context of the entire sim, rather than just the Game screen, whenever that is going to be done.

@pixelzoom pixelzoom removed their assignment Dec 15, 2021
marlitas added a commit to phetsims/counting-common that referenced this issue Jan 11, 2023
marlitas added a commit to phetsims/number-suite-common that referenced this issue Jan 11, 2023
@pixelzoom pixelzoom added the documentation Improvements or additions to documentation label Jan 15, 2023
@chrisklus
Copy link
Contributor Author

Making a note from a discussion that @zepumph and I had: we should talk about hoe the view drives the model regarding countingObjects' bounds, and the ways that could be improved if desired.

@chrisklus chrisklus changed the title Complete model.md and implementation-notes.md model.md and implementation-notes.md Apr 7, 2023
@chrisklus
Copy link
Contributor Author

@amanda-phet and I are working on these in google docs!

chrisklus added a commit that referenced this issue Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation status:blocks-sim-publication
Projects
None yet
Development

No branches or pull requests

3 participants