Skip to content

Non Functional Requirements

Jump to bottom
Sivasurya Santhanam edited this page Jun 21, 2018 · 2 revisions

Below you find the non functional requirements which we try to comply to. They are prioritised by order, the most important on top.

Code

  • Easy to understand - Make the code speak for itself (by following the link:Code-Guidelines[code guidelines]) to allow others to understand what you do and to reuse your code.
  • KISS (Keep It Simple) - Don't try to solve problems which are not there. Write just the code which gets you to your goal.
  • Modular - Due to the nature of the project, a modular architecture is necessary to keep it adaptable to different use cases as well as to make it easy to reuse code.
  • DRY (Don't Repeat Yourself) - Look if there is code which you can extend for your use case instead of writing something similar.
  • Maintainable - Keep in mind that others have to maintain your code. This meand to make it understandable, but also to

Software

  • Intuitive - Each GUI element should be understandable without explanation
  • Fast - The search should provide answers in a few seconds
  • Responsive - The GUI should be usable in different resolutions
Clone this wiki locally