|
To allow the administration and usage of surveys to measure the social performance and impact we need to provide a framework to cover various Social Performance Management tools, e.g. PPI, MPAT or USAID-PATs.
Resources used for research:
# | Title | User Story | Importance | Notes |
---|---|---|---|---|
1 | Create new survey | As an administrator I want to create a new survey to collect SPM data. | Must Have |
|
2 | Add general information | As an administrator I want to add additional fields to a survey to collect general information. | Must Have | |
3 | Add questions to a survey | As an administrator I want to add questions with their related answers and options to a survey to create a questionnaire. | Must Have | |
4 | Add look-up tables | As an administrator I want to add look-up tables to a survey to map scores to well known KPIs. | Must Have | |
5 | Assign default look-up table | As an administrator I want to assign a look-up table as default to allow KPI viewing an client info. | Must Have | |
6 | Enable survey | As an administrator I want to enable a survey per tenant to allow collecting of SPM data. | Must Have | |
7 | Enforce survey | As an administrator I want to enforce the collection of SPM data to report data. | Must Have | |
8 | Fill survey | As a staff I want to collect SPM data provided by a survey to track my clients. | Must Have | |
9 | View survey | As a staff I want to view collected SPM data to benchmark my clients. | Must Have | |
10 | Report targets | As a manager I want to compare SPM data with targets to track my impact | Must Have |
Any preconditions before a client can use the new functionality
Any rules to be applied for a client or user when using this functionality
List of attributes to be captured for the new functionality
Attribute | Description | Notes |
---|---|---|
Survey | A Survey is a collection of general information, and specific questions. | |
Question | A Question has answers and options assigned and is used as the basis of all needed or wanted KPI computation | |
Scorecard | Holds the results of a questionnaire | |
Look-up Tables | Define KPIs for certain ranges retrieved through the scorecard |
none
none
Include any mockups, diagrams or visual designs relating to these requirements.
List of error scenarios and the action - if message is to be displayed, then text of the message.
HTTP Method | Resource | Query Parameter | Request Body | Response Body | Error codes |
---|---|---|---|---|---|
POST | /surveys | n/a | Survey | surveyId | 400, 404, 500 |
GET | /surveys | key, name, countryCode | n/a | List<Survey> | 400, 500 |
GET | /surveys/{id} | n/a | n/a | Survey | 400, 404, 500 |
POST | /surveys/{id}/lookUpTables | n/a | LookUpTable | surveyId, lookUpTableId | 400, 404, 500 |
GET | /surveys/{id}/lookUpTables | key | n/a | List<LookUpTable> | 400, 500 |
GET | /surveys/{id}/lookUpTables/{id} | n/a | n/a | LookUpTable | 400, 404, 500 |
POST | /surveys/{id}/scorecards | n/a | Scorecard | surveyId, scorecardId | 400, 404, 500 |
GET | /surveys/{id}/scorecards | clientId, createdBy, createdOn | n/a | List<Scorecard> | 400, 500 |
GET | /surveys/{id}/scorecards/{id} | n/a | n/a | Scorecard | 400, 500 |
none
Below is a list of questions to be addressed as a result of this requirements document:
Question | Outcome |
---|---|
(e.g. How we make users more aware of this feature?) | Communicate the decision reached |