Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SRS - Formatting errors #212

Open
matpetro opened this issue Nov 11, 2024 · 0 comments
Open

SRS - Formatting errors #212

matpetro opened this issue Nov 11, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@matpetro
Copy link
Collaborator

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.

@matpetro matpetro added the documentation Improvements or additions to documentation label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants