Changes between Initial Version and Version 1 of BluePrint/SurveyTool/ADAT


Ignore:
Timestamp:
06/13/11 16:05:00 (11 years ago)
Author:
Michael Howden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/SurveyTool/ADAT

    v1 v1  
     1= Survey Tool Blue Print - Assessment Data Analysis Tool (ADAT) =
     2
     3== Introduction ==
     4ADAT will provide IFRC with a flexible tool to create assessments and analyse the data.
     5
     6== Features ==
     7 * Easily create customised assessments
     8 * Reusable list of questions which can be used in multiple assessments
     9
     10== Back Ground ==
     11This blue print describes the extensions to use the Survey Tool to implement the ADAT project for IFRC. It is based on the initial specification from the GSoC project: http://wiki.sahanafoundation.org/doku.php/foundation:surveytool_spec, although reflecting changes due to improvements to the Sahana Eden Framework and lessons learned from the GSoC project.
     12
     13== Data Model ==
     14[[Image(http://yuml.me/diagram/scruffy/class/# Cool UML Diagram, [Template]+1->0..*[Sections], [Sections]+1- >0..*[Section Question], [Question]++1->0..*[Section Question ])]]
     15
     16=== Template ===
     17Table to store all thee information about an assessment
     18
     19=== Sections ===
     20Used to split an assessment up into different sections
     21
     22=== Section Question ===
     23Table to link questions with sections
     24
     25=== Question ===
     26Library of questions which can be reused on numerous assessment templates. This table will have to store all information needed to construct the questions (widget definition). 
     27
     28=== Completed Assessments ===
     29Tables & Resources to store data for completed assessments will be defined dynamically when that assessment is first filled.
     30
     31== Work Flow ==
     32=== Create Assessment Template ===
     33 1. Enter basic data for the Template
     34 1. Add a Section to the Template
     35 1. Add a Question to the Section, by either:
     36  1. Creating a new Question
     37  1. Reusing an existing Question
     38 1. Repeat steps 2. & 3. as required
     39
     40=== Fill Assessment ===
     41 1. Select a Assessment Template to complete
     42 1. ''If this is a new template''
     43  1. Create a table based on data in the Template, Sections, Section Questions and Question.
     44  1. Lock all of the records in these tables (Template can't be modified after it's been used.
     45  1. Optional: Create a copy of the template (and components) so that it can be modified at a later date.
     46 1. Open the table for the Assessment Template in a regular Create view
     47
     48
     49=== Analyse Assessment ===
     50==== Basic ====
     51 1. Select a Assessment Template which has been completed
     52 1. View all the results for that Assessment Template using
     53  1. Tables (& PDF & Excel)
     54  1. Plots (Graphs)
     55
     56==== Advanced ====
     57 1. Select a question (or range of questions)
     58 1. View all the results for that question from ALL Assessment Template using
     59  1. Tables (& PDF & Excel)
     60  1. Plots (Graphs)
     61
     62== Questions ==
     63 * Is there currently the functionality to split a create form into different "sections" (with headings)
     64 * Should the Internationalisation be done using T(...) & language files, or could custom code be do for this to store translations in the database so that translations can be entered more easily dynamically.
     65
     66== Tasks ==
     67To be completed...
     68