Added readme

abunai-dev · Nov 3, 2023 · 4762db7 · 4762db7
1 parent 160628e
commit 4762db7
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,45 @@
+# Overview
+
+This repository includes a prototype for collecting uncertainties in software designs.
+
+It allows a comprehensive overview of known uncertainties that can impact data confidentiality.
+Additionally, software architects can collaborate on the knowledge through GitHub issues, which can be accessed from within the tool.
+
+To access the tool use the following link:
+https://abunai-dev.github.io/UncertaintySourceArchive/
+
+
+# Functions
+![Table View](screenshot_table_total.png)
+![Search and Filter](screenshot_search_filter.png)
+Table View:
+F2: Sort Table Ascending/Descending
+F3: Filter Table by Multiple Properties
+F4: Search for specific Uncertainty
+F5: Reset Filters and Search
+
+
+![Uncertainty Detail Information](screenshot_uncertainty_top.png)
+![Uncertainty Detail Classification](screenshot_uncertainty_classification.png)
+![Uncertainty Detail Example and Discussion](screenshot_uncertainty_bottom.png)
+Uncertainty Detail View:
+F6: Show Definition
+F7: Show Keywords
+F8: Show Classification Properties
+F9: Show Example
+F10: Show Related Uncertainties
+F11: Link to Discussion on GitHub
+
+![Classification Category Information](screenshot_classification_top.png)
+![Classification Category Description](screenshot_classification_bottom.png)
+Classification Detail View:
+F12: Show Description
+F13: Show Options
+F14: Show Graphic Representation
+F15: Filter Table by Option
+F16: Link to Discussion on GitHub
+Table 5.1: Features included in prototype
+
+
+
+
diff --git a/screenshot_classification_bottom.png b/screenshot_classification_bottom.png
diff --git a/screenshot_classification_top.png b/screenshot_classification_top.png
diff --git a/screenshot_search_filter.png b/screenshot_search_filter.png
diff --git a/screenshot_table_total.png b/screenshot_table_total.png
diff --git a/screenshot_uncertainty_bottom.png b/screenshot_uncertainty_bottom.png
diff --git a/screenshot_uncertainty_classification.png b/screenshot_uncertainty_classification.png
diff --git a/screenshot_uncertainty_top.png b/screenshot_uncertainty_top.png