Home

Welcome to the surveyDesigner wiki!

An app to support questionnaire design processes. This app is one of the 3 tools to support survey processes through Design, Collection & Analysis.

Those components relies on a minimized technology stack that includes:

1. A data collection server: Kobotoolbox with its XlsForm standard,
2. A data documentation server: RIDL based on CKAN
3. A data processing server: RstudioConnect with dedicated package and app based on R statistical language

Entry Points

• Project Scope: https://github.com/unhcr-americas/surveyDesigner/wiki/A-Scope:-What-would-be-a-success-for-the-mission-as-user-of-the-app
• Project documentation: https://unhcr-americas.github.io/surveyDesigner
• Wiki to document the development: https://github.com/unhcr-americas/surveyDesigner/wiki/Home
• Ticket Dashboard: https://github.com/orgs/unhcr-americas/projects/1

Architecture

You can find on this image a schema of the package based on two high level object-oriented R6 class:

• referential - this object reflects all the elements managed by the global-survey-coordinato

• context - this object reflects all the contextualization suported by the regional-survey-support. It reflects the referential based on requirement for each country

• questionnaires - this object reflects all the elements managed by the survey-focal-point. It transforms the referential into one or more than one contextualized questionnaires

Tools for project documentation

Issues / Tickets

The issues interface shows the content of the request and then the list of questions and answers. It also contains a full history of status changes.

You can unsubscribe from emails received in an issue by changing the "Notifications" menu in the bottom right hand column of the interface.

Ticket content

Ticket template are created through the following files https://github.com/unhcr-americas/surveyDesigner/tree/main/.github

You will see in our tickets that there are at least three parts:

• As...
• Validation Criteria
• Technical How

These parts are primarily for developers to know what and how to handle the requirement. Upon validation, you will see the "Validation Criteria" section evolve with instructions or screenshots that allow you to validate the ticket. We ask you to:

• To check the boxes of each of these criteria if you validate them
• Add a message in the thread of the issue to let us know if you validate it completely, or if there are corrections to make.

Then, we will close the ticket and reopen all those that would be necessary

Monitoring tickets with Dashboard

A dashboard is used to overview tickets

• Tickets that developers are working on are blocked on are listed in the blocked column. Please explore these tickets and answer the questions.
• Once you respond or are named in a ticket, you will receive an email if a new response is added
• Validation is done by the clients, on tickets added to the Project "Validation" column

Link to Survey Designer project ticket progress dashboard

Note about check-boxes

If you open the issue from within the Board, the check-boxes do not work properly. You need to open the issue as full screen in a new tab:

• either CRTL + Click from the board to open in a new tab,
• or click a second time on the title so that the issue opens up in a new page.

Sprint

Development work is organized through Scope, Sprints and Regular Situation Points so that there's always a prototype to showcase