Difference between revisions of "Questionnaire Programming"

Jump to: navigation, search
 
(79 intermediate revisions by 7 users not shown)
Line 1: Line 1:
This chapters relates to the process of digitization of a questionnaire, and not to the process of developing content for [[Questionnaire_Design:Questionnaire Design|Questionnaire Design]].  
<onlyinclude>This topic relates to the process of developing a [[Computer-Assisted Personal Interviews (CAPI)]] version of a questionnaire. We strongly recommend that you first develop the content for your questionnaire according to the [[Questionnaire Design]] topic. When you have a paper based survey then you should follow the steps in this article.</onlyinclude>


The main challenge when digitizing large household surveys common in the field of impact evaluation is to keep an overview over the content and functionality of a questionnaire when it is written in code. There are many tools online where surveys can be developed in a click-and-drag fashion. While they do a great job displaying a questionnaire written in code in a human readable form, they only do so while looking at a single question or a small section of a questionnaire. Learning to write and understand questionnaire programming languages is imperative for anyone who wants to code a large and complex high quality CAPI questionnaire.


= Read First =
This topic on Questionnaire Programming links to but does not focus on the syntax of any questionnaire programming language. The focus is on how to plan your work when going from a blank paper to final code, and how to maintain a protocol for high quality throughout that process. This topic also lists a lot of tools that will be helpful along the way.


You should never start coding your survey before you and your research team has more or less finalized the content of your survey. The reason for this is that even minor content changes might require that you have to re-do something that you have already spent a long time one. See questionnaire design (content development) and questionnaire programming (functionality development) as two strictly separate tasks which requires the research team's full attention separately. Starting with functionality or late major changes to questionnaire content, are sometimes inevitable, but they are by far the most common reason for quality issues in CAPI survey data.
== Read First ==


This chapter related to the set up, work flow and organization of questionnaire programming rather than best practices in SurveyCTO coding best practices. The two topics are related, and you will find many links to such articles. If you want to browse SurveyCTO coding best practices then go to the stand alone chapter called [[SurveyCTO coding practices]].
We strongly recommend that you never start coding your survey before you and your research team has more or less finalized the content of your survey. The reason for this is that even minor content changes could require that you have to re-do something in your programming that you have already spent a long time on. [[Questionnaire Design|Questionnaire design]] (content development) and questionnaire programming (functionality development) should be seen as two strictly separate tasks which requires the research team's full attention separately. Starting with functionality or late major changes to questionnaire content, are sometimes inevitable, but they are by far the most common reason for quality issues in CAPI survey data.


==Important articles often forgotten about==
===Important articles often forgotten about===
*[[Questionnaire_Encryption:|Questionnaire Encryption]] - read before creating your questionnaire
*[[SurveyCTO Form Settings#Encryption|Questionnaire Encryption]] - read before creating your questionnaire
*[[Data_Quality_Checks:|Survey Data Quality Checks]] - read while you are programming your questionnaire. Best practice is to develop data quality checks in parallel to coding your the questionnaire.
*[[Monitoring Data Quality|Survey Data Quality Checks]] - read while you are programming your questionnaire. Best practice (and easiest) is to develop data quality checks in parallel to coding your the questionnaire.
*[[SCTO_Questionnaire_Version_Control:|Updating a Questionnaire already in use]] - Important best practice when you realize that you need to make changes to a survey you have started to use in the field already.
*[[SurveyCTO Form Settings#Version control of questionnaires already used in the field|Version control of questionnaires already used in the field]] - Important best practice when you realize that you need to make changes to a survey you have already started using in the field.


= Topics =
== General Guidelines on Questionnaire Programming ==


The following topics are ordered in a more or less chronological order
The following articles are listed in a typical chronological order, but it is probably worthwhile for a beginner to questionnaire programming to read up on the whole process before getting started.


== Choosing Software ==
==== Choosing Hardware ====
There are [[Other_CAPI_Software:several software|several software]] on the market for CAPI data collection. The rest of this chapter will provide advice assuming that your project will be using [[SurveyCTO]]. Many of the practices are valid in other software too, but SurveyCTO is assumed.
CAPI data collection is most commonly done using an Android tablet. For simple survey instruments, an Android phone may be sufficient. Very few CAPI software are designed for use with Apple or Window systems. For guidance on which tablets to select, see [[Computer-Assisted_Personal_Interviews_(CAPI)#CAPI_Hardware|CAPI Hardware Specifications]]


== Using the Server ==
==== Choosing Software ====
There are [[Computer-Assisted_Personal_Interviews_(CAPI)#CAPI_Software|several software]] on the market for CAPI data collection. The rest of this chapter will provide advice assuming that your project will be done using [[SurveyCTO Coding Practices|SurveyCTO]]. Many of the practices are valid in other software too, but SurveyCTO is assumed.


You can either [[SCTO_Server_Setup:set up your own server|set up your own server]], but if your project is a DIME project you can use DIME's [[DIME_Development_server:development server|development server]] until your project require its own server
==== Setting up a Server ====


== Create a questionnaire ==
Information on setting up your own server on the [[SurveyCTO_Server_Management | SurveyCTO Server Management]] page.
The easiest way to start with one of SurveyCTO's [[SCTO_Template_Forms:|template forms]]. You can either program your questionnaire in the form builder or in an Excel sheet. We recommend that your default approach is [[SCTO_Excel_Programming:|the Excel sheet]]. Regardless what method you use to program your questionnaire, and regardless if you start with an empty instrument or use a survey that have been used before, it is important that you [[SCTO_Encryption:|encrypt]] your questionnaires.


== How to start coding your questionnaire ==
=== Create a questionnaire ===
The easiest way to start is with one of SurveyCTO's [[SurveyCTO_Programming_Work_Flow#Template_Forms|template forms]]. You can either program your questionnaire in the [[SurveyCTO Programming#Form Builder|form builder]] online or in an Excel sheet on your computer. We recommend that your default approach is [[SurveyCTO_Programming#Programming in Excel|programming in an Excel sheet]]. Regardless of what method you use to program your questionnaire, and if you start with an empty instrument or use a survey that have been used before, it is important that you [[SurveyCTO Form Settings#Encryption|encrypt]] your questionnaires.


Before starting the programming, read this article on [[SCTO_Form_Settings:|form settings]] first.
=== How to organize the programming of a questionnaire ===


The organization of how to approach coding a questionnaire (or perhaps the lack therefore) is in our experience the most common reason for serious bugs that should have been avoidable. [[SCTO_Questionnaire_Programming_Organization:|questionnaire organization programming]] will provide you with a
Before starting the programming, read this article on [[SurveyCTO Form Settings|form settings]] first.


== Updating a questionnaire already used in the field ==
The organization of how to approach coding a questionnaire (or perhaps the lack therefore) is in our experience the most common reason for serious bugs that are easily avoidable. [[SurveyCTO_Programming_Work_Flow|Questionnaire organization programming]] will provide you with a general overview, [[SurveyCTO_Programming_Work_Flow#Pseudo Code|pseudo code]] is a practical approach how to get started with your code. After you have planned the programming of your questionnaire, but before you start the programming, go through this list of [[SurveyCTO Coding Practices|SurveyCTO best practices]] and make sure that your planning is in-line with all recommended best practices.


While SurveyCTO have fucntionality to allow edits to questionniares already in use, this is not advisable, instead [[SCTO_Questionnaire_Version_Control:|create a new separate version of your questionnaire]].
=== Updating a questionnaire already used in the field ===
 
While SurveyCTO have functionality to allow edits to questionnaires already in use, this is not advisable, instead [[SurveyCTO Form Settings#Version control of questionnaires already used in the field|create a new separate version of your questionnaire]].
 
== Additional Resources ==
*DIME Analytics’ guidelines on [https://github.com/worldbank/DIME-Resources/blob/master/survey-instruments.pdf survey design and pilot]
If you want to browse SurveyCTO coding best practices, then go to the stand alone chapter called [[SurveyCTO Coding Practices|SurveyCTO coding practices]].
 
[[Category: Primary Data Collection]] [[Category: Questionnaire Design]]

Latest revision as of 18:32, 29 April 2021

This topic relates to the process of developing a Computer-Assisted Personal Interviews (CAPI) version of a questionnaire. We strongly recommend that you first develop the content for your questionnaire according to the Questionnaire Design topic. When you have a paper based survey then you should follow the steps in this article.

The main challenge when digitizing large household surveys common in the field of impact evaluation is to keep an overview over the content and functionality of a questionnaire when it is written in code. There are many tools online where surveys can be developed in a click-and-drag fashion. While they do a great job displaying a questionnaire written in code in a human readable form, they only do so while looking at a single question or a small section of a questionnaire. Learning to write and understand questionnaire programming languages is imperative for anyone who wants to code a large and complex high quality CAPI questionnaire.

This topic on Questionnaire Programming links to but does not focus on the syntax of any questionnaire programming language. The focus is on how to plan your work when going from a blank paper to final code, and how to maintain a protocol for high quality throughout that process. This topic also lists a lot of tools that will be helpful along the way.

Read First

We strongly recommend that you never start coding your survey before you and your research team has more or less finalized the content of your survey. The reason for this is that even minor content changes could require that you have to re-do something in your programming that you have already spent a long time on. Questionnaire design (content development) and questionnaire programming (functionality development) should be seen as two strictly separate tasks which requires the research team's full attention separately. Starting with functionality or late major changes to questionnaire content, are sometimes inevitable, but they are by far the most common reason for quality issues in CAPI survey data.

Important articles often forgotten about

General Guidelines on Questionnaire Programming

The following articles are listed in a typical chronological order, but it is probably worthwhile for a beginner to questionnaire programming to read up on the whole process before getting started.

Choosing Hardware

CAPI data collection is most commonly done using an Android tablet. For simple survey instruments, an Android phone may be sufficient. Very few CAPI software are designed for use with Apple or Window systems. For guidance on which tablets to select, see CAPI Hardware Specifications

Choosing Software

There are several software on the market for CAPI data collection. The rest of this chapter will provide advice assuming that your project will be done using SurveyCTO. Many of the practices are valid in other software too, but SurveyCTO is assumed.

Setting up a Server

Information on setting up your own server on the SurveyCTO Server Management page.

Create a questionnaire

The easiest way to start is with one of SurveyCTO's template forms. You can either program your questionnaire in the form builder online or in an Excel sheet on your computer. We recommend that your default approach is programming in an Excel sheet. Regardless of what method you use to program your questionnaire, and if you start with an empty instrument or use a survey that have been used before, it is important that you encrypt your questionnaires.

How to organize the programming of a questionnaire

Before starting the programming, read this article on form settings first.

The organization of how to approach coding a questionnaire (or perhaps the lack therefore) is in our experience the most common reason for serious bugs that are easily avoidable. Questionnaire organization programming will provide you with a general overview, pseudo code is a practical approach how to get started with your code. After you have planned the programming of your questionnaire, but before you start the programming, go through this list of SurveyCTO best practices and make sure that your planning is in-line with all recommended best practices.

Updating a questionnaire already used in the field

While SurveyCTO have functionality to allow edits to questionnaires already in use, this is not advisable, instead create a new separate version of your questionnaire.

Additional Resources

If you want to browse SurveyCTO coding best practices, then go to the stand alone chapter called SurveyCTO coding practices.