From 7c5d776cd7c56a6274889d1262c2391088f7285b Mon Sep 17 00:00:00 2001
From: "Dr. Gernot Starke" <gs@gernotstarke.de>
Date: Tue, 12 Dec 2023 17:17:16 +0100
Subject: [PATCH] add clarity / coherence requirement

---
 ...3-18-clarity-in-technical-documentation.md | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100755 requirements/C/_posts/2023-03-18-clarity-in-technical-documentation.md

diff --git a/requirements/C/_posts/2023-03-18-clarity-in-technical-documentation.md b/requirements/C/_posts/2023-03-18-clarity-in-technical-documentation.md
new file mode 100755
index 0000000..69fa3bf
--- /dev/null
+++ b/requirements/C/_posts/2023-03-18-clarity-in-technical-documentation.md
@@ -0,0 +1,32 @@
+---
+title: "Clarity in technical documentation"
+tags: usable reliable
+related: clarity, coherence, understandability, legibility 
+permalink: /requirements/clarity-in-technical-documentation
+---
+
+>### Background
+>
+>The system is fairly large, and maintained/developed by an internationally distributed and highly heterogenerous, diverse and volatile development team. 
+
+
+<div class="quality-requirement" markdown="1">
+
+**Stimulus**: Users referr to the documentation to understand technical details or troubleshoot issues.
+
+**Artifact**: Technical Documentation
+
+**Response**: The documentation provides coherent and intelligible explanations and instructions.
+
+**Response Measure** (aka _metrics_):
+
+* At least 90% of the system-specific terms used in the documentation are defined in a glossary section accessible within the same document or via direct links.
+* The readability score of the documentation, as measured by the Flesch-Kincaid Readability Test, should be between 60 to 70, which corresponds to a 8th to 9th-grade reading level, ensuring it is easily understandable by the average dev-team member.
+</div><br>
+
+
+
+
+
+
+