Skip to content

Commit

Permalink
Merge pull request #171 from arc42/#170-fix-typos-and-missing-qualities
Browse files Browse the repository at this point in the history
major update, fixing >20 typo-bugs
  • Loading branch information
gernotstarke authored Jun 27, 2024
2 parents 518d385 + fc567c9 commit 2bad8dd
Show file tree
Hide file tree
Showing 27 changed files with 106 additions and 28 deletions.
23 changes: 19 additions & 4 deletions _todo-qualities/2099-01-01-controllability.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
---
title:
tags:
related: a,b,c
permalink: /qualities/q
title: Controllability
tags: usable operable
related: usability
permalink: /qualities/controllability
---

### In context of Usability

> The interface will allow the user to perceive that they are in control and will allow appropriate control.
>
> [Stanford University Usability Principles](https://improvement.stanford.edu/resources/usability-principles)
### In context of DevOps

>In the context of DevOps, controllability refers to the ability to effectively manage, manipulate, and influence the behavior of systems and processes throughout the software development and deployment lifecycle. Key aspects are:
>
>* Infrastructure Control
>* Deployment Control
>* Monitoring and Observability
>
>[Devops.com](https://devops.com/the-devops-pendulum-agility-vs-control/)
File renamed without changes.
31 changes: 31 additions & 0 deletions nreqs/_posts/2023-03-18-data-throughput-for-visual-test-system.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "Data Throughput for Visual Test System"
tags: efficient usable
related: throughput, efficiency, performance, capacity
permalink: /requirements/data-throughput-for-visual-test-system
---

<div class="quality-requirement" markdown="1">

**Background**: Our hardware boards enhance simple webcams with image recognition capabilities.
Our (proprietory) advanced image recognition algorithms are embedded in the firmware of these boards.

These boards are used for example in license-plate recognition systems in many public parking facilities.

The quality requirement relates to the firmware test and verification system.

**Scenario**: An update of the firmware is available (usually with additional functionality of improved recognition performance). Prior to release, we need to verify that this updated firmware recognizes with at least the accuracy of the previous versions.
The test and verification process needs approximately 1000 hours of video and image playback.

**Metric**: The 1000 real-hours of video need to be played back to the device-under-test in less than 72 hours.

That means that a video taken in real-time needs to be played back to the device-under-test in at least 14-fold speed. The test and verification system needs to ensure this throughput from both software and hardware (I/O, network and processing capabilities).

</div><br>







Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Anticipated Workplace Environment
tags: usable
related: appropriateness
related: Functional Appropriateness
permalink: /qualities/anticipated-workplace-environment
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/A/_posts/2022-12-28-appearance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Appearance
tags: usable
related: ease-of-use, learnability, self-descritiveness, user-interface-aesthetics
related: ease-of-use, learnability, self-descriptiveness, user-interface-aesthetics, attractiveness
permalink: /qualities/appearance
---

Expand Down
15 changes: 15 additions & 0 deletions qualities/A/_posts/2022-12-28-attractiveness.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Attractiveness
tags: usable
related: usability, clarity, User interface aesthetics, user experience, user assistance
permalink: /qualities/q
---

>Attractiveness summarizes properties that make software appealing to users and stakeholders. Attractive software typically exhibits:
>
>* User-friendly and intuitive design: The software is easy to navigate and use, minimizing learning curves and maximizing efficiency.
>* Robust functionality and regular updates: The software offers powerful features and is continuously improved to meet evolving user needs.
>* Optimized performance with minimal errors: The software runs smoothly, with quick load times and few errors, enhancing user productivity.
>* Compatibility with various systems: The software works well across different platforms and hardware configurations.
>
> [BGOSoftware: How to define beautiful software](https://www.bgosoftware.com/blog/how-to-define-beautiful-software-5-key-characteristics/)
4 changes: 2 additions & 2 deletions qualities/A/_posts/2022-12-28-auditability.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Auditability
tags:
related:
tags: operable
related: transparency, traceability, operability, observability, devops-metrics
permalink: /qualities/auditability
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/C/_posts/2022-12-28-coherence.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Coherence
tags: usable efficient
related: consistent
related: Consistency
permalink: /qualities/coherence
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/C/_posts/2022-12-28-compliance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Compliance
tags: secure safe usable reliable efficient suitable
related: security, safety, usability, reliability, efficience, testability
related: security, safety, usability, reliability, efficiency, testability
permalink: /qualities/compliance
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/C/_posts/2022-12-28-composability.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Composability
tags: flexible
related: modularity, autonomy, discoverability, reusability, interoperability
related: modularity, autonomy, reusability, interoperability
permalink: /qualities/composability
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/C/_posts/2022-12-28-consistency.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Consistency
tags: usable efficient
related: understandability, conherence
related: Understandability, Coherence
permalink: /qualities/consistency
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/C/_posts/2022-12-28-convenience.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Convenience
tags: usable
related: usability, easy-of-use, user-assistance
related: usability, ease-of-use, user-assistance
permalink: /qualities/convenience
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/C/_posts/2022-12-28-credibility.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Credibility
tags: reliable
related: accountability, acceptance, usability, user-engagement
related: accountability, usability, user-engagement
permalink: /qualities/credibility
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/E/_posts/2022-12-28-elasticity.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Elasticity
tags: flexible
related: adaptability, scalabiltiy, flexibility
related: adaptability, scalability, flexibility
permalink: /qualities/elasticity
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Functional appropriateness
title: Functional Appropriateness
tags: usable reliable suitable
related: usability, functionality, functional-suitability, suitability
permalink: /qualities/functional-appropriateness
Expand Down
2 changes: 1 addition & 1 deletion qualities/O/_posts/2022-12-28-operability.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Operability
tags: usable operable
related: usability, user-error-protection, controlability, user-error-robustness, conformity
related: usability, user-error-protection, controllability, operrobustness
permalink: /qualities/operability
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Operational and Environment Requirements
tags: operable
related: expected-physical-environment, operational-constraints
related: expected-physical-environment, operational-constraint
permalink: /qualities/operational-environment-requirements
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Performance efficiency
title: Performance
tags: efficient
related: efficiency, resource-efficiency, speed
permalink: /qualities/performance-efficiency
permalink: /qualities/performance
---

Definition:
Expand Down
2 changes: 1 addition & 1 deletion qualities/P/_posts/2022-12-28-personalization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Personalization
tags: flexible
related: customizabilty
related: Customizability
permalink: /qualities/personalization
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/P/_posts/2022-12-28-portability.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Portability
tags: flexible operable
related: integrability, compatibility, flexibility, installability, interoperability, maintainability, configurability, replaceability
related: compatibility, flexibility, installability, interoperability, maintainability, configurability, replaceability
permalink: /qualities/portability
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/R/_posts/2022-12-28-resource-efficiency.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ permalink: /qualities/resource-efficiency
<hr>

A special case is [_performance efficiency_](/qualities/performance-efficiency):
A special case is [_performance_](/qualities/performance) (synonym: _performance efficiency_):

>Perform its functions within specified time and throughput parameters and be efficient in the use of resources under specified conditions
>
Expand Down
2 changes: 1 addition & 1 deletion qualities/R/_posts/2022-12-28-response-time.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Response Time
tags: efficient
related: performance efficiency, speed, time behaviour
related: performance, speed, time behaviour
permalink: /qualities/response-time
---

Expand Down
2 changes: 1 addition & 1 deletion qualities/R/_posts/2022-12-28-responsiveness.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Responsiveness
tags: usable, efficient
related: response time, useability, user experience
related: response time, usability, user experience
permalink: /qualities/responsiveness
---

Expand Down
17 changes: 17 additions & 0 deletions qualities/T/_posts/2022-12-28-transparency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Transparency
tags: reliable
related: clarity, understandability, usability
permalink: /qualities/transparency
---

>**Transparency**:
>
>* the quality of being easy to see through.
>
>* a situation in which business and financial activities are done in an open way without secrets, so that people can trust that they are fair and honest:
>[Cambridge Dictionary](https://dictionary.cambridge.org/dictionary/english/transparency)
<hr class="with-no-margin"/>

2 changes: 1 addition & 1 deletion qualities/U/_posts/2022-12-28-user-error-protection.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: User error protection
tags: usable operable
related: usability, operability, user-error-robustness
related: usability, operability, robustness
permalink: /qualities/user-error-protection
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/M/_posts/2000-12-12-modular-data-analysis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Modular System for Data Analysis"
tags: efficient flexible
related: composability, modularity, integrability, stability
related: composability, modularity, stability
permalink: /requirements/modular-system-for-data-analysis
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Capacity to process 1000 sensor inputs per minute"
tags: efficient
related: time behaviour, speed, performance efficiency
related: time behaviour, speed, performance
permalink: /requirements/capacity-to-process-sensor-inputs
---

Expand Down

0 comments on commit 2bad8dd

Please sign in to comment.