MEQ docs draft

Author: Peter Johnson

docs/student/MEQ.md

@@ -0,0 +1,47 @@
+# Module Evaluation Questionnaires (MEQ)
+
+## Information for students
+
+Students can provide feedback to teachers to recognise good practice and help improve teaching.
+
+Each module can contain one or more Module Evaluation Questionnaire (MEQ), which appears in the content as a separate type of Set. When accessed, the MEQ is seen in the context of all open MEQs at the time (across all modules). 
+
+Student responses are treated as follows:
+
+- Responses are saved when 'SUBMIT' is pressed, with confirmation provided.
+- Multiple responses are possible. Responses are initialised by the last saved submission, and can then be edited and re-submitted with the 'SUBMIT' button.
+- Only the last response is used when collecting data.
+- All responses are confidential to all users of the platform, i.e. the author of the response is never associated with the response.
+- No responses are visible to teachers while an MEQ is open.
+
+
+### Access to MEQ data
+
+MEQ data are only accessible to teachers, and only under certain conditions. A minimum of 5 responses are required, after which data is accessible to teachers depending on question type and user role. Note that the 'moderator' is assigned per-module by central admin, and it is typically the director of studies. Data availability is as follows: 
+
+#### Numerical data (Likert scale):
+
+|MEQ is open | Response is about a specific teacher? | Available to |
+|--|--|--|
+|Yes |n/a|Data not available|
+|No |No|Any teacher on the module|
+|No |Yes|Only that teacher and the moderator|
+  
+
+#### Text data (comments):
+
+|MEQ is open | Response is about a specific teacher? | Moderator approved? |Available to |
+|--|--|--|--|
+|Yes |n/a| n/a |Moderator (only)|
+|No |No| No |Moderator (only)|
+|No |No| Yes |Any teacher on the module|
+|No |Yes| No |Moderator (only)|
+|No |Yes| Yes |Only that teacher and the moderator|
+
+### Progress bar 
+
+When a student has open MEQs that are incomplete, a progress bar will appear on the home page. When all MEQs are complete, or none is open, the bar will disappear.
+
+## Information for teachers
+
+There is an additional guide, [MEQ for teachers](../../teacher/guides/MEQ).

docs/teacher/guides/MEQ.md

@@ -0,0 +1,39 @@
+# Module Evaluation Questionnaires (MEQ)
+
+## Information for teachers
+
+Students can provide feedback to teachers to recognise good practice and help improve teaching.
+
+General information about MEQs is available on the relevant [student page on MEQ](../../../student/MEQ).
+
+This page provides additional information relevant to teachers.
+
+### Create an MEQ
+
+An MEQ is a special type of Set. It can be created in the _Content_ tab of a module in TEACHER mode. MEQs use templates that are controlled centrally on the tenant (e.g. school or university). To modify or extend the available templates, speak to your administrator.
+
+When you add an MEQ from a template, the following can be edited:
+
+- Name of the MEQ
+- Visibility (Opening and closing dates; and 'manually hidden' toggle) 
+- Which teachers from the module are evaluated (if any)
+
+Once an MEQ has been created, it becomes a separate copy; future changes to the central templates will not appear in the MEQ you have created. The only options to edit the MEQ are the above listed properties. 
+
+There is no limit to the number of MEQs that can be created in a module.
+
+### Teacher-specific questions
+
+The template question includes general content and response areas that are tailored to the questionnaire environment. One option for each response area is to designate a question as 
+
+_'Repeat statements for each teacher'_
+
+For questions with this toggle, the question repeats identically for each teacher listed in the MEQ settings. The default setting is no teachers, and the teachers need to be manually added in the settings by selecting from teachers who are enrolled on the module.
+
+### Data visibility
+
+An [overview of data visibility](../../../student/MEQ#access-to-meq-data) is provided on the student page on MEQ. The moderator(s) for each module are set by the Administrators, and are visible on the _Teachers_ tab in the module in TEACHER mode.
+
+## Information for students
+
+See also, [MEQ for students](../../../student/MEQ).

mkdocs.yml

@@ -28,6 +28,7 @@ nav:
       - Answering Questions: "student/answering_questions.md"
       - Response Areas: "student/response_areas.md"
       - Text Editing: "student/lexdown_student.md"
+      - Module evaluation questionnaires (MEQ): "student/MEQ.md"
       - FAQ: "student/faq.md"
 
   - Teachers:
@@ -40,9 +41,9 @@ nav:
           - Analytics: "teacher/guides/analytics.md"
           - Good practice: "teacher/guides/good-practice.md"
           - Guidance: "teacher/guides/guidance.md"
+          - Module evaluation questionnaires (MEQ): "teacher/guides/MEQ.md"
           - FAQ: "teacher/guides/faq.md"
 
-
       - Reference:
           - Content management: "teacher/reference/content_management.md"
           - Latex functionality: "teacher/reference/latex_functionality.md"
@@ -145,17 +146,17 @@ plugins:
   - git-revision-date-localized:
       fallback_to_build_date: true
   - macros
-  - evaldocsloader:
-      enabled: !ENV [ENABLE_EVALDOCS, true]
-      functions_announce_endpoint: "https://prod-api.lambdafeedback.com/evaluation-functions/registered"
-      api_key:
-        !ENV [
-          API_KEY,
-          "WiOS1vMpQyTuGL06ZJxjG1eZd2P0SPvuVzHpr6zjkTIJ33U2t5O5NWaZboWBv8aV",
-        ]
-      dev_section: ["Advanced", "Evaluation Functions", "Deployed Functions"]
-      user_section: ["Teachers", "Reference", "Evaluation Functions"]
-      github_token: !ENV [GITHUB_TOKEN, ""]
+  # - evaldocsloader:
+  #     enabled: !ENV [ENABLE_EVALDOCS, true]
+  #     functions_announce_endpoint: "https://prod-api.lambdafeedback.com/evaluation-functions/registered"
+  #     api_key:
+  #       !ENV [
+  #         API_KEY,
+  #         "WiOS1vMpQyTuGL06ZJxjG1eZd2P0SPvuVzHpr6zjkTIJ33U2t5O5NWaZboWBv8aV",
+  #       ]
+  #     dev_section: ["Advanced", "Evaluation Functions", "Deployed Functions"]
+  #     user_section: ["Teachers", "Reference", "Evaluation Functions"]
+  #     github_token: !ENV [GITHUB_TOKEN, ""]
 
 # Extra variables, accessible within markdown pages
 extra: