Skip to content

Commit c2c166e

Browse files
AndrejKiriavillela
andauthored
Update survey design guidelines (#105)
* Add metadata and questions to each survey * Remove the questions in markdown format. * Move metadata to survey READMEs * Remove survey admin mention * Add more metadata * Add Stripe guidelines to the Survey reminders section * Add Survey Monkey guidelines * Add guidelines from Harvard * Add some info to README * Add Scribbr and SmartSurvey guidelines * Remove unnecessary H1 * Remove old and add new guidelines * Add references * Remove notes * Remove metadata * Remove conflicting lines --------- Co-authored-by: Adriana Villela <50256412+avillela@users.noreply.github.com>
1 parent e834e9d commit c2c166e

File tree

2 files changed

+21
-12
lines changed

2 files changed

+21
-12
lines changed

end-user-surveys/README.md

+19-11
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ This document is intended to outline best practices for long running and durable
33

44
The OpenTelemetry community would like to gather data about end-users including their experiences, preferences, perceptions and opinions about OpenTelemetry. This data can be used to inform priorities within various OpenTelemetry projects.
55

6-
# Community survey best practices
7-
86
### Community survey principles
97
- User feedback should be a mix of qualitative and quantitative:
108
- Qualitative to validate/invalidate hypotheses
@@ -18,10 +16,25 @@ The OpenTelemetry community would like to gather data about end-users including
1816
- Survey Best Practices
1917
- Summarizing and reporting results
2018

21-
### Survey reminders:
22-
- Be respectful of the survey-takers' time, in general try to keep the survey short in duration, with specific and targeted questions. You can always ask if you can follow up with them to get deeper context.
23-
- We want to measure improvements too, so using trendable questions helps us assess how we’re doing
24-
- We encourage mix of general and targeted surveys
19+
### Survey design guidelines
20+
21+
1. Aim for less than 15 questions that are short and concise
22+
2. Group questions into logical sections
23+
3. Use demographic questions (filtering, grouping)
24+
4. Start with easy, closed-ended questions
25+
5. Use up to one open-ended question
26+
6. Set questions to 'Required' only if necessary
27+
7. Use clear language without jargon and acronyms.
28+
8. Do not collect Personally Identifiable Information (PII)
29+
9. Avoid leading questions (written in a way that influences survey responses)
30+
10. Avoid loaded question (assumes something about the respondents that might not be true)
31+
11. Avoid double-barreled questions (asks people to give only one answer when asking about two things)
32+
12. Avoid absolutes (always, every, etc.)
33+
13. Be careful with negation in a questions
34+
14. Ensure questions options are mutually exclusive (e.g. 1-9, 10-99)
35+
15. Include 'Other' option if relevant
36+
37+
For mode details check guidelines from [Stripe](ttps://stripe.com/en-cz/guides/atlas/survey-design-principles), [Survey Monkey](https://www.surveymonkey.com/learn/survey-best-practices/?), [Harvard Law School](https://hnmcp.law.harvard.edu/wp-content/uploads/2012/02/Arevik-Avedian-Survey-Design-PowerPoint.pdf), [Scribbr](https://www.scribbr.com/methodology/survey-research/), or [Smart Survey](https://www.smartsurvey.co.uk/survey-questions/types)
2538

2639
### Helpful questions and considerations:
2740

@@ -44,11 +57,6 @@ The OpenTelemetry community would like to gather data about end-users including
4457
- What can be summarized?
4558
- Do you have any conclusions, insights or recommendations?
4659

47-
Survey best practices resources were heavily inspired by these resources:
48-
49-
- [Survey Research Step-by-step Guide](https://www.scribbr.com/methodology/survey-research/)
50-
- [Types of Survey Questions](https://www.smartsurvey.co.uk/survey-questions/types)
51-
5260
### Basic survey template
5361

5462
Surveys header information should include:

end-user-surveys/docs-usability/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ The purpose the OpenTelemetry Communications SIG gather insights about the usabi
1717
* start: 2025-10-10
1818
* end: 2025-11-9
1919
* sample-size: 48
20-
* number-of-questions: 21
20+
* number-of-questions: 21
21+

0 commit comments

Comments
 (0)