Added about and usage scenarios

VODAN-Tech · Jul 7, 2020 · c914fa7 · c914fa7
1 parent 57d01b4
commit c914fa7
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 16 deletions.
diff --git a/docs/.vscode/settings.json b/docs/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "restructuredtext.confPath": "${workspaceFolder}"
+}
diff --git a/docs/about/about.rst b/docs/about/about.rst
@@ -0,0 +1,9 @@
+************************
+About the VODAN in a Box
+************************
+
+**VODAN in a Box (ViaB)** is a toolset composed of:
+
+- Data Stewardship Wizard (DSW) - to capture and store data based on WHO's COVID-19 CRF;
+- FAIR Data Point (FDP) - to publish metadata about the COVID-19 CRF dataset and other pandemic-related content;
+- WHO COVID-19 Rapid Version CRF Semantic Data Model - this semantic data model has been embedded in DSW to provide semantically-rich RDF export to the data entered with the DSW.
diff --git a/docs/about/usagescenarios.rst b/docs/about/usagescenarios.rst
@@ -0,0 +1,24 @@
+***************
+Usage Scenarios
+***************
+
+The **VODAN in a Box (ViaB)** toolset can be used in the following scenarios:
+
+Data-entry only
+---------------
+
+In this scenario, only the VODAN DSW and its COVID-19 semantic data model are used as a data-entry tool. Users can fill in the DSW's web form with data to report COVID-19 cases. 
+
+Normally, this scenario is indicated for the cases where metadata about the data does not need to be published.
+
+Metadata publication only
+---------------
+
+In this scenario, only the VODAN FDP is used to publish the pandemic-related content. This option is indicated for the cases where data have already been captured and only the FAIR metadata about them need to be published.
+
+Data could have been made available from other CRF-entry tools and extracted directly from databases of information systems such as electronic health record systems.
+
+Data-entry and metadata publication (complete package)
+---------------
+
+In this scenario, the whole **VODAN in a Box** is used, covering the data capture, semantic data generation and metadata publishing. 
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,20 +1,9 @@
-.. VODAN in a Box documentation master file, created by
-   sphinx-quickstart on Wed Jul  1 20:33:41 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to VODAN in a Box's documentation!
-==========================================
+VODAN in a Box Documentation
+============================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
+   :caption: About
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   about/about
+   about/usagescenarios