Skip to content

Commit

Permalink
fix and refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau committed Jun 7, 2024
1 parent c4f1c59 commit 74d4f52
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 27 deletions.
46 changes: 19 additions & 27 deletions docs/user-guide/setup-feedback.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,27 @@
# Adding a customized feedback section

To conclude our protocol, we integrate a customized feedback activity. This choice of ending with participant feedback is just one of many possibilities, demonstrating the adaptability of ReproSchema to diverse research needs.
To conclude our protocol, we integrate a customized feedback activity. This
choice of ending with participant feedback is just one of many possibilities,
demonstrating the adaptability of ReproSchema to diverse research needs.

```json
{
"@context": "https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc4/contexts/generic",
"@type": "reproschema:Field",
"@id": "feedback",
"prefLabel": "Feedback",
"description": "schema to record text response of overall feedback of the protocol",
"schemaVersion": "1.0.0-rc4",
"version": "0.0.1",
"question": {
"en": "Please leave any comments or suggestions on the study so we can improve it (or skip):",
"es": "Deje cualquier comentario o sugerencia sobre el estudio para que podamos mejorarlo (u omitir):"
},
"ui": {
"inputType": "textarea"
},
"responseOptions": {
"valueType": "xsd:string"
}
}
```json linenums="1"
--8<-- "example_ehi/activities/user_guide/items/feedback.jsonld"
```

The `feedback` item in this activity ([`5_feedback`](https://github.com/ReproNim/reproschema-demo-protocol/blob/main/activities/5_feedback/items/feedback)) is specifically designed to gather open-ended responses, allowing participants to share their thoughts and suggestions:
The `feedback` item in this activity
([`5_feedback`](https://github.com/ReproNim/reproschema-demo-protocol/blob/main/activities/5_feedback/items/feedback))
is specifically designed to gather open-ended responses, allowing participants
to share their thoughts and suggestions:

- Item Structure: The item `feedback` is set up with an identification and purpose, indicated by its '@id' and descriptive fields.
- Item Structure: The item `feedback` is set up with an identification and
purpose, indicated by its `@id` and descriptive fields.

- Question Prompt: The `question` is presented in both English and Spanish, encouraging participants to provide comments on their study experience.
It’s formatted to be inclusive, giving participants the option to skip if they choose.
- Question Prompt: The `question` is presented in both English and Spanish,
encouraging participants to provide comments on their study experience. It’s
formatted to be inclusive, giving participants the option to skip if they
choose.

- UI Configuration for Open Responses: The choice of `textarea` as the `inputType` in the ui configuration facilitates extended text input, enabling participants to express detailed feedback comfortably.
Accordingly, `valueType` in the `responseOptions` has been set as `"xsd:string"`.
- UI Configuration for Open Responses: The choice of `textarea` as the
`inputType` in the ui configuration facilitates extended text input, enabling
participants to express detailed feedback comfortably. Accordingly,
`valueType` in the `responseOptions` has been set as `"xsd:string"`.
19 changes: 19 additions & 0 deletions example_ehi/activities/user_guide/items/feedback.jsonld
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"@context": "https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc4/contexts/generic",
"@type": "reproschema:Field",
"@id": "feedback.jsonld",
"prefLabel": "Feedback",
"description": "schema to record text response of overall feedback of the protocol",
"schemaVersion": "1.0.0-rc4",
"version": "0.0.1",
"question": {
"en": "Please leave any comments or suggestions on the study so we can improve it (or skip):",
"es": "Deje cualquier comentario o sugerencia sobre el estudio para que podamos mejorarlo (u omitir):"
},
"ui": {
"inputType": "textarea"
},
"responseOptions": {
"valueType": "xsd:string"
}
}

0 comments on commit 74d4f52

Please sign in to comment.