search

smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

Game Physics: Goal Statement Merged #152

Open oluowoj opened 5 years ago

oluowoj commented 5 years ago

The updated Goal Statements for TM2D as per the feedback from SRS presentation are:

GS1: Given the kinematic properties, and forces applied on a set of rigid bodies, determine their new position and velocities over a period of time in non-collision and/or collision states.

GS2: Given the kinematic properties and forces applied on a set of rigid bodies, determine their new orientations and angular velocities over a period of time in non-collision and/or collision states.

GS3: Given the kinematic properties of a set of rigid bodies, determine if any of them will collide with one another over a period of time.

Questions:

  1. I merged GS4 into GS1 and GS2 from the original SRS. Do I have to implement all of the goal statements?
  2. I created a branch and I am going to commit all changes in the branch first, so do you want to see my changes to the SRS as comments or its okay to make all the changes straight off, and add any comments or questions?
smiths commented 5 years ago

@oluowoj, I would rephrase your GS1 as follows: "Given the kinematic properties, and forces (including any collision forces) applied on a set of rigid bodies, determine their new position and velocities over a period of time." GS2 can be worded similarly. I don't think you need GS3, since collision forces are included in GS1 and GS2. Since the two goals start with the same text, you can move this to the statement introducing the two goals.

With respect to your questions, I'm not sure what you mean by implementing the goal statement. The project will involve finishing the requirements, completing the design, implementation and testing. Through all of this you will be implementing the goal statements.

You can change the SRS to what you think is best. You can highlight your changes with a separate comment or question. Since you will be using the comment command, we can turn the comments off in the pdf if we want to.

oluowoj commented 5 years ago

Noted, I will modify my changes with your feedback.

My question about implementing all the goal statement was to make sure the scope of the project will be within the time frame that we have, to complete it. But that's fine. Thanks for your feedback.

smiths commented 5 years ago

Sounds good. I appreciate your concerns, but I don't think you need to worry that the project scope is too big. Remember that for the implementation you can use existing libraries when appropriate. You don't have to implement everything. If the scope should become an issue we can move some of the implementation to "phase 2," which would be something that is completed after the course is concluded.

oluowoj commented 5 years ago

Thanks this can be closed