Merge pull request #45 from alan-turing-institute/improve_phrasing

small improvements to phrasing & info Closes #37
alan-turing-institute · May 4, 2024 · 748e2e1 · 748e2e1
2 parents bb98ed6 + 7e2f591
commit 748e2e1
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 21 deletions.
diff --git a/webapp/home.py b/webapp/home.py
@@ -50,9 +50,16 @@
 
 st.write("#")
 st.markdown(
-    "The Alan Turing Institute's TRIC-DT and CPC DT Hub are conducting a "
-    "community pulse check on the topic of' Assurance of Digital Twin "
-    "Systems'."
+    """
+    The Alan Turing Institute's
+     [Turing Research and Innovation Cluster in Digital Twins
+    ](https://www.turing.ac.uk/research/research-projects/tric-dt)
+     and
+     [Conncected Places Catapult Digital Twin Hub](
+        https://digitaltwinhub.co.uk/)
+     are conducting a community pulse check on the topic of
+     'Assurance of Digital Twin Systems'.
+    """
 )
 st.markdown(
     "Are you developing, deploying or overseeing digital twin technologies"
@@ -129,6 +136,10 @@
 st.write("#")
 st.write("#")
 
+st.markdown(
+    "<h4>" "To begin the survey, please enter the Captcha below.</h4>",
+    unsafe_allow_html=True,
+)
 # Captcha
 # Define a container to encapsulate captcha and user input fields
 captcha_cont = st.empty()

diff --git a/webapp/pages/01_Consent.py b/webapp/pages/01_Consent.py
@@ -103,7 +103,7 @@
 ### Further Information and Contact
 This survey is overseen by the Alan Turing Institute. If you have any questions
 or require further information about the survey or the TEA-DT project, please
-contact Dr. Sophie Arana at sarana@turing.ac.uk.
+contact us at digitaltwins@turing.ac.uk.
 Your insights are invaluable to us, and we thank you for contributing to the
 advancement of trustworthy and ethical digital twins.
 
@@ -126,7 +126,7 @@
     "I understand that I will not benefit directly from participating in this "
     "research.",
     "The purpose and nature of this study and the survey have been explained "
-    "to me in writing and I am able to contact someone to ask questions.",
+    "to me above and I am able to contact someone to ask questions.",
     "I understand that participation in this survey involves answering "
     "questions on my views and my work with regard to the assurance of digital"
     " twins, and will include discussing my own perceptions and attitudes"

diff --git a/webapp/pages/04_Current_Practices.py b/webapp/pages/04_Current_Practices.py
@@ -102,7 +102,8 @@
     This can include a range of activities such as conducting a system audit,
     validating a dataset, carrying out training around ethical practices or
     achieving certified compliance with a specific standard.
-    """    )
+    """
+    )
 
     if st.button("Proceed"):
         st.session_state.continue_clicked = True
@@ -153,6 +154,12 @@
             questions["asset_data_sharing"]["type"],
             options=questions["asset_data_sharing"].get("options"),
             key=ASSET_DATA_SHARING_STATE_KEY,
+            help="""
+            In the context of digital twins, **asset-related data**
+             refers to the digital representation of information
+             pertaining to the characteristics, status,
+             and usage of physical assets in real-time.
+            """,
         )
 
         if asset_data_sharing == "Yes":

diff --git a/webapp/pages/08_Communicating_Assurance.py b/webapp/pages/08_Communicating_Assurance.py
@@ -76,9 +76,10 @@
 st.info(
     """One way to present a structured argument that clearly shows
 how your assurance measures meet ethical goals is to use graph notation
-to create a structured argument. This structured approach simplifies complex information
-and standardizes assurance communication, allowing stakeholders to see the
-direct connections between actions and outcomes.
+to create a structured argument. This structured approach simplifies
+ complex information and standardizes assurance communication,
+ allowing stakeholders to see the direct connections
+ between actions and outcomes.
 """
 )
 
@@ -111,6 +112,13 @@
         )
     )
 
+if need_for_visual_tool == "I need to know more about this tool to decide":
+    st.info(
+        "If you would like to learn more later, visit "
+        "our [documentation]"
+        "(https://alan-turing-institute.github.io/AssurancePlatform/)"
+    )
+
 preparedness_for_argument = question_generator.generate_streamlit_element(
     questions["preparedness_for_argument"]["question"],
     questions["preparedness_for_argument"]["type"],

diff --git a/webapp/pages/10_Follow_up.py b/webapp/pages/10_Follow_up.py
@@ -43,8 +43,8 @@
     """
 You are almost done!
 Here is a final chance to share any other remarks
- and to share your email if you would like to be 
-kept up to date.
+ and to share your email if you would like to be
+ kept up to date.
 """
 )
 

diff --git a/webapp/streamlit_utils.py b/webapp/streamlit_utils.py
@@ -185,6 +185,7 @@ def generate_streamlit_element(
         question_type: str,
         options: Optional[list] = None,
         key: Optional[str] = None,
+        help: Optional[str] = None,
     ) -> Any:
         """
         Returns the appropriate Streamlit input element
@@ -265,6 +266,7 @@ def generate_streamlit_element(
                 key=widget_key,
                 on_change=store_in_session,
                 args=(key,),
+                help=help,
                 index=None,
             )
         else:

diff --git a/webapp/survey_questions.py b/webapp/survey_questions.py
@@ -41,16 +41,15 @@
             "Place Leadership",
             "Rail",
             "Renewable Energy",
-            "Research"
-            "Smart Cities",
+            "Research" "Smart Cities",
             "Supply Chain and Logistics",
             "Technology",
             "Telecommunications",
             "Transport",
             "Utilities",
             "Waste and Recycling",
             "Water",
-            "Other"
+            "Other",
         ],
         "section": "community_composition",  # Example section
     },
@@ -447,7 +446,7 @@
     },
     "relevance_of_principles": {
         "tag": "relevance_of_principles",
-        "question": "Please rate, for each Gemini principle individually,"
+        "question": "Please rate, for each of the following Gemini principles,"
         " the extent to which it focuses on issues that you believe to be"
         " relevant for your work",
         "type": "likert",
@@ -462,7 +461,7 @@
     },
     "challenge_in_application": {
         "tag": "challenge_in_application",
-        "question": "For each of the following ethical principles, please rate"
+        "question": "Please rate, for each of the following Gemini principles,"
         " how challenging you find it to determine if you have adequately"
         " addressed the principle in practice.",
         "type": "likert",
@@ -477,7 +476,7 @@
     },
     "operationalization_challenges": {
         "tag": "operationalization_challenges",
-        "question": "For those rated very difficult or extremely difficult"
+        "question": "For those rated very challenging or extremely challenging"
         " to operationalize, what are the main challenges you face?",
         "type": "text_area",
         "section": "ethical_assurance_frameworks",
@@ -534,11 +533,11 @@
         "goals?",
         "type": "likert",
         "options": [
-            "Very prepared",
-            "Somewhat prepared",
-            "Neutral",
-            "Somewhat unprepared",
             "Not prepared at all",
+            "Somewhat unprepared",
+            "Neutral",
+            "Somewhat prepared",
+            "Very prepared",
         ],
         "section": "evidence_based_assurance",
     },