OKKM-insights / OKKM.insights

OrbitWatch
Apache License 2.0
1 stars 0 forks source link

SRS - Formatting errors #212

Open matpetro opened 5 days ago

matpetro commented 5 days ago

Description

Overall formatting done well. There are, however, minor mistakes throughout the document that should be fixed to improve consistency (and I may not have caught everything):

Some minor typos found in the doc, e.g. p.46 "funtion" is misspelled Some external resources given as links can be instead be references. E.g. p.45 NFR-PR3, p.46 NFR-PR5 (especially this one, which cites an academic article, should definitely be a reference!) Some NFRs reference other NFRs. To facilitate navigation, hyperlink the referenced NFRs. NFR-PR8 has a weird upside down exclamation mark next to 50 Gb; weird typesetting error? NFR-OE2: Success rate of 99.5; missing percentage? Other suggestions:

The symbol ℙ was used to denote probability, but it wasn't obvious to me (as I'm used to seeing P or Pr instead). To avoid confusion you can state what this is in Section 4. Mathematical symbols such as t_{uptime} etc. are introduced in the fit criterion itself. This is fine; another alternative would be to put all such definitions in Section 4 as well, and then they can be reused throughout the document.