{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# How to get feedback from students on your notebooks?\n",
    "\n",
    "Getting feedback from students on the notebooks you use in your teaching is very important to be able to improve them in a meaningful way.  \n",
    "We offer two ways in which you can get feedback from students on your notebooks:\n",
    "1. Through a **[short generic online survey](#generic)** integrated into your notebooks\n",
    "2. Through a more **[detailed survey](#specific)** which can be **customized to your needs** and administered online or on paper in your class\n",
    "\n",
    "## Short generic survey <span id=\"generic\">&nbsp;</span>\n",
    "\n",
    "We provide a generic survey that you can embed into your notebooks to **collect anonymous feedback** from those who use your notebooks.  \n",
    "The survey is designed to be short and easy to fill out, with three questions (both in English and French) focusing on helpfulness, usability and a free text field for comments. You can see the survey form below.  \n",
    "The survey will automatically collect data for you. We then process the data and provide you with a summary of the feedback regularly.  \n",
    "\n",
    "How to use it?\n",
    "\n",
    "**Step 1:** Add a cell to your notebook and copy the following piece of Python code in it (below is the code to use in R):\n",
    "\n",
    " ```python\n",
    "from IPython.display import IFrame\n",
    "IFrame('https://www.surveymonkey.com/r/NOTOSURVEY?notebook_set=COURSENAME&notebook_id=NOTEBOOKNAME', 600, 800)\n",
    "```\n",
    "\n",
    "**Step 2:** In the code, replace the two following elements (attention: DO NOT USE SPACES, use dash or underscore to replace spaces):\n",
    "* `COURSENAME`: replace by name of the project or course, e.g. `MecaDRIL` or `PHYS-101`\n",
    "* `NOTEBOOKNAME`: replace by the name or code of the notebook in the course, e.g. `01-Logan` \n",
    "\n",
    "\n",
    "Example of complete URL:  \n",
    "`https://www.surveymonkey.com/r/NOTOSURVEY?notebook_set=MecaDRIL&notebook_id=01-Logan`\n",
    "\n",
    "**Optional:** It can be useful to add one line of text above the code cell with the survey to indicate to your students that you would appreciate their feedback on your notebook.  \n",
    "You could use something like: *Did you like this Notebook? Why don't you give us some feedback using the completely anonymous form below (just execute the cell to see it)? Thank you!*\n",
    "\n",
    "**Demo:**\n",
    "\n",
    "Execute the cell below to see the survey:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from IPython.display import IFrame\n",
    "IFrame('https://www.surveymonkey.com/r/NOTOSURVEY?notebook_set=noto-poc-notebooks&notebook_id=survey-monkey-demo', 600, 900)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If you use R, here is the equivalent code:\n",
    "\n",
    "```R\n",
    "library(IRdisplay)\n",
    "IRdisplay::display_html('<iframe src=\"https://www.surveymonkey.com/r/NOTOSURVEY?notebook_set=noto-poc-notebooks&notebook_id=survey-monkey-demo\" width=600, height=900></iframe> ') \n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Detailed customized survey <span id=\"specific\">&nbsp;</span>\n",
    "\n",
    "If you would like to have **more detailed feedback** or if these questions do not match your context, then we can **design a survey** for you.  \n",
    "You can see [in this file an example of a questionnaire](Docs/NotebookSurvey.pdf) with customized questions, which can be administered either on paper in your class or online. We can help you with designing the questions, administering the questionnaire as well as analyzing the data.\n",
    "\n",
    "Just **drop us an email at [noto-support@groupes.epfl.ch](mailto:noto-support@groupes.epfl.ch)** if you would like to use one of those questionnaires."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.9"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}