Skip to content

Latest commit

 

History

History
34 lines (30 loc) · 8.33 KB

QualityAttributes.md

File metadata and controls

34 lines (30 loc) · 8.33 KB

Definitions, Acronyms, Abbreviations

# Abbreviation or Acronym Definition
1 IR Multimedia Systems multimedia information retrieval means the process of searching for and finding multimedia documents; the corresponding research field is concerned with building multimedia search engines
2 OOP Object-oriented programming (OOP) is a programming paradigm based on the concept of “objects”, which can contain data and code: data in the form of fields (often known as attributes or properties), and code, in the form of procedures (often known as methods)
3 Operating systems is system software that manages computer hardware, software resources, and provides common services for computer programs
4 Quality Attribute is a measurable or testable property of a system that is used to indicate how well the system satisfies the needs of its stakeholders
5 SOLID In object-oriented computer programming, SOLID is a mnemonic acronym for five design principles intended to make software designs more understandable, flexible, and maintainable

Quality Attributes

For each quality attribute it provides name, description, motivation (rationale for selecting), measurable metrics and priorities from business and architecture points of view.

The metrics show whether a particular quality attribute is achieved or not.

The components where metric is measured is noted as well.

Name Explanation Motivation for selecting Metrics Business value Architecture viewpoint
Availability TBD TBD TBD TBD TBD
Conceptual Integrity The software shall be decomposed into well-structured modules according to functional decomposition TBD The code review process shall be established to make sure the modules are structured according to functional decomposition Low Middle
Interoperability The proposed solution shall have the ability to be integrated with online and offline Multimedia IR systems in the common way The system shall be able to be integrated to any IR Multimedia Systems with a high level of easiness The code review process shall be defined to make sure the OOP, SOLID principles and MVC pattern are going to be used High High
Learnability The system shall have the UI allowing users to quickly become familiar with it and be able to make good use of all their features and capabilities.The user guideline and working instruction shall be available It is required to help the user to get familiar with the system TBD High High
Maintainability The system shall be able to undergo changes with a high level of easiness The following changes might happen frequently: - changes applied to the UI like adding new screen; - adding new multimedia formats to support; - new metadata search criteria to handle. - new offline or online IR Multimedia Systems can be easily integrated The code review process shall be defined to make sure the OOP, SOLID principles and MVC pattern are going to be used Middle High
Manageability The system shall be monitorable via UI and logging.The system shall support debugging as well It is applied to easily support the systems operations in the fields The code review process shall be established to make sure the Each component shall use UI and logging component: - to save any important events - to disk via logging; - to show the progress of processing in UI; - to show any important events - to user in UI; - to provide the user with an ability to cancel the processing in UI Middle High
Performance The same as for the whole system, the UI shall respond in less than 1 second. As there might be time-consuming jobs, it shall show the current progress for such operations to provide the user with a status It is applied to support great UX The regular performance test shall be performed to check it High Low
Portability The software shall support all wide known desktop/laptop operating systems - Windows, MacOS, Linux Ubuntu with the latest update.No support of the web or mobile platform required Those platforms are selected to cover about 100% of desktop user TBD High Middle
Reusability The system components shall be usable in other functionality or other flows It is applied for deduplication of implementation and to reduce the implementation time spent) A common library is going to be created to keep the following functions used by several components: - To work with configuration; - Logging functions; - Common UI functions; Middle High
Reliability If the system is going to fail during an operation, it shall report the operation status to user with error description and roll back all applied changes for this operation TBD TBD High High
Scalability TBD TBD TBD TBD TBD
Security Each multimedia file shall have “read only” attribute set up after processing on Windows It is applied not to allow it easily change multimedia after processing Functional test shall be created to check if all multimedia files after processing are marked with “read only” flag Low Low
Supportability During abnormal function, the software shall provide the information to find and to solve the issues via prompting user in UI and saving detailed information into the log file. Also it has: - to show the progress of processing in UI; - to show any important events to user in UI; - to provide the user with an ability to cancel the processing in UI. The user shall be able to change a log level as configurable parameter It is applied to easily support the systems operations in the fields and for monitoring. TBD - Add a description for Administration tools and specific deployment aspects TBD High Middle
Testability TBD TBD TBD TBD TBD
Traceability The system code shall be traceable to the requirements To make possible to measure the product readiness TBD Low Low
Usability The system shall be intuitive, easy to localize (to support multiple time zones, languages, etc.) and globalize. In addition, the installation package must be provided for each supportable platform to increase the usability of product TBD TBD High Middle