smiths / caseStudies

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

Game Physics: Lacking Non-Functional Requirements #53

Open Mornix opened 6 years ago

Mornix commented 6 years ago

Section 5.2 is very vague and lacking with respect to the non-functional requirements. The section could be greatly expanded.

smiths commented 6 years ago

Hello @Mornix. To make these issues easier to address, could you include more information? What is the title of section 5.2? What are some examples of missing non-functional requirements. What else should be added? If it makes sense, this issue could be split into multiple issues.

Mornix commented 6 years ago

(Issue #29)

The Game Physics SRS mentions which nonfunctional requirements (Section 5.2) are a priority, but never details what the requirements for those categories are.

screen shot 2018-05-04 at 12 06 40 pm

For example:

smiths commented 6 years ago

@Mornix, please add the nonfunctional requirements that you have mentioned to the SRS. This would improve the documentation. In some cases you mention the NFRs, but include questions on how they are measured or checked. If you could make an attempt at how they might be written as requirements, that would be great. We can review as you go along. We don't have to have perfect NFRs, but you have noticed a weakness in the original documentation that should be improved upon.

Once the new NFRs are in place, we will have to create another issue to port these changes to the Drasil version of the Game Physics SRS.