search

smiths / caseStudies

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

SRS Review (GamePhysicsSRS) #1 #167

Open karolserkis opened 5 years ago

karolserkis commented 5 years ago

Hello, @oluowoj

Some formatting observations:

  1. The title page doesn't have your contact information.
  2. The Introduction section should have "TamiasMini2D" along with the \progname{} abbreviation just to introduce the your physics library formally and then use the abbreviation/acronym throughout the rest of the documentation.

GamePhysicsSRS.pdf

oluowoj commented 5 years ago

What type of contact info were you looking for on the title page?

image

Comparing with @smiths 's template

image