Changes between Initial Version and Version 1 of DeveloperGuidelines/Survey


Ignore:
Timestamp:
10/01/11 10:20:31 (10 years ago)
Author:
graeme
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/Survey

    v1 v1  
     1[[TOC]]
     2= Survey Module =
     3The survey module is used to generate and analyse surveys.
     4== The data model ==
     5[[Image(wiki:BluePrint/SurveyTool/ADAT:survey_implementation.png)]]
     6=== survey_template ===
     7The template is the root table and acts as a container for the questions that will be used in a survey.
     8
     9=== survey_sections ===
     10The questions can be grouped into sections this provides the description of the section and the position of the section within the template
     11
     12=== survey_question ===
     13This holds the actual question and a unique string code is used to identify the question. The type of question is also set here. More details of the questions can be found on the section of [#types (Question Types)]
     14
     15It is possible for the same question to be used in different templates. If this is done then analysis across templates becomes possible, although this has not yet been implemented.
     16
     17=== survey_question_metadata ===
     18This is used to hold additional details of the question. The valid metadata that can be stored will be defined by the [#types (question type)].
     19
     20=== survey_question_list ===
     21
     22=== survey_series ===
     23=== survey_response ===
     24=== survey_answer ===
     25== The Question Types [=#types]==
     26== The Question Widgets ==
     27== Code Overview ==
     28=== modules/s3/s3survey.py ===
     29=== models/survey.py ===
     30=== controllers/survey.py ===
     31== Terminology Used ==
     32 * assessment the response to a single questionnaire used in the survey
     33 * questionnaire the list of questions (I think of it as the physical piece of paper that needs to be filled in, whilst the assessment includes both the questionnaire and the answers)
     34 * series is a survey that has been set up for a particular event and holds all of the responses to the assessments
     35 * template is a list or each question that will be held in the questionnaire and a template can be shared across series, thus we can have many series using the same template and in the future it may be possible to do some analysis across series that share the same template.
     36 * widget all question types are managed by widgets, one to validate and display the data in a form the other to analyse and produce charts