phetsims / projectile-data-lab

"Projectile Data Lab" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
0 stars 0 forks source link

model.md: Does it adequately describe the model, in terms appropriate for teachers? Has it been reviewed by the sim designer? #184

Closed samreid closed 4 months ago

samreid commented 6 months ago

https://github.com/phetsims/projectile-data-lab/blob/main/doc/model.md

pixelzoom commented 6 months ago

I read through model.md for code review #32, and it looks good to me. The sim designer typically has sign off, and that would be @matthew-blackman.

Reminder that model.md is linked into the PhET-iO deliverables (in the wrapper index?). So in addition to teachers, the audience is PhET-iO clients (instructional designers, developers, ...)

pixelzoom commented 5 months ago

Since this sim is now in RC testings, should this issue be closed?

matthew-blackman commented 4 months ago

The model.md file has been updated and reviewed. Labeling for cherry-pick.

arouinfar commented 4 months ago

@matthew-blackman related to #299, projectile-sampling-distribution will also need a model.md file. It can be a placeholder that points to projectile-data-lab's model.md. For example: https://github.com/phetsims/concentration/blob/main/doc/model.md

Without this placeholder, there will be a broken link in phet-io-guide.md because it points to sim-name's model.md.

KatieWoe commented 4 months ago

Looks good in rc.2