Changes between Initial Version and Version 1 of docs/overview

Timestamp:

Nov 8, 2013 6:53:12 AM (11 years ago)

Author:

quinn

Comment:

--

docs/overview

@@ +1 @@
+= Overview of Usage =
+
+== Pulso ONG consists of three types of data ==
+
+=== Participants ===
+Only a phone number is stored for participants. They can be added to the system manually by a Pulso ONG administrator, or if a participant wishes to participate in a survey they can add their number to the database by sending an SMS to us containing `JOIN` (or `UNIRSE`), or to unsubscribe from surveys they can send `LEAVE` (or `DEJAR`).
+
+=== Surveys ===
+A collection of questions scheduled to send on a specific date. A survey can have an ''introduction message'' defined that is sent initially to greet the participant.
+
+=== Questions ===
+The questions defined for each survey. Questions are formatted using a syntax (see below) force the participant to ''choose one option'', ''choose one-or-more options'', or to give a freeform response. Questions are ranked to be sent in a specific order.
+
+==== Question syntax ====
+
+The question text is limited to 160 characters (SMS limit). 
+
+There are three available types of questions:
+
+===== 1. Choose one option =====
+Include the options behind `)` brackets, e.g.:
+{{{
+Have you worked in the US in the past 5 years? A) Yes, B) No
+}}}
+The responded can reply either `A` or `B`; if the system doesn't understand the response it will send the participant a message asking them to try again.
+
+===== 2. Freeform response =====
+For a multiple-choice-style question, include the options behind `]` brackets, e.g.:
+{{{
+Which abuse have you experienced (choose one-or-more): A] Fraud, B] Threats, C] Physical abuse, D] Verbal abuse, E] Extortion, F] Blacklisting, G] Human trade
+}}}
+The response can include any number of single letters with any kind of separator (`A B C` or `A,B,C`); if the system doesn't understand the response it will send the participant a message asking them to try again.
+
+===== 3. Freeform response =====
+To allow a freeform response to a question, simply end the question with a question mark (`?`). E.g.,
+{{{
+How did you hear about your job?
+}}}
+Any reply will be accepted.
+