Skip to content

Commit ac0d3a8

Browse files
committed
docs: initiate user role personas and data collection strategy
1 parent 518cf1f commit ac0d3a8

File tree

6 files changed

+662
-0
lines changed

6 files changed

+662
-0
lines changed

docs/source/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@ Contributing
3636

3737
contributing
3838

39+
**********
40+
Community
41+
**********
42+
43+
.. toctree::
44+
:maxdepth: 2
45+
46+
user-roles-framework
47+
slack-polling-guide
48+
3949
******
4050
Others
4151
******
Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
.. _slack-polling-guide:
2+
3+
==========================
4+
Slack Polling Guide for User Roles
5+
==========================
6+
7+
This guide explains how to conduct polls in Slack to gather user role information for the
8+
AboutCode community.
9+
10+
Why Poll in Slack?
11+
------------------
12+
13+
Slack polls are an effective way to:
14+
15+
- Engage active community members
16+
- Gather information from users who are already participating
17+
- Get quick feedback without requiring formal surveys
18+
- Build community awareness of user diversity
19+
20+
Preparing Your Poll
21+
-------------------
22+
23+
Before creating a poll, consider:
24+
25+
1. **Timing**: Post during active hours when most community members are online
26+
2. **Frequency**: Don't poll too frequently to avoid survey fatigue
27+
3. **Clarity**: Make questions clear and easy to answer
28+
4. **Anonymity**: Decide if responses should be anonymous or attributed
29+
30+
Poll Options in Slack
31+
---------------------
32+
33+
Slack offers several ways to conduct polls:
34+
35+
**1. Native Slack Polls (Recommended)**
36+
- Use Slack's built-in poll feature (if available in your workspace)
37+
- Type `/poll` followed by your question and options
38+
- Example: ``/poll "What's your primary role?" "Compliance Manager" "Security Engineer" "Developer" "Other"``
39+
40+
**2. Emoji Reactions**
41+
- Post a message with multiple options
42+
- Ask users to react with specific emojis for each option
43+
- Easy to set up and participate
44+
45+
**3. Thread-based Responses**
46+
- Post a question and ask users to reply in threads
47+
- Allows for more detailed responses
48+
- Good for open-ended questions
49+
50+
**4. Third-party Poll Apps**
51+
- Use Slack apps like Simple Poll, Polly, or SurveyMonkey
52+
- More features but requires app installation
53+
54+
Sample Poll Messages
55+
--------------------
56+
57+
**Quick Role Identification Poll**
58+
59+
.. code-block:: text
60+
61+
👋 Hey #general! We're working on understanding our community better to improve
62+
documentation and resources.
63+
64+
Quick poll: What best describes your primary role with AboutCode tools?
65+
66+
React with:
67+
📋 = Compliance/Legal
68+
🔒 = Security/Vulnerability Management
69+
💻 = Developer/Engineer
70+
⚙️ = DevOps/Operations
71+
🎓 = Student/Researcher
72+
👔 = Management/Product
73+
🤝 = Contributor/Maintainer
74+
❓ = Other (reply in thread)
75+
76+
**Detailed Role Information Request**
77+
78+
.. code-block:: text
79+
80+
📊 Community Role Survey
81+
82+
We're building a user roles framework to better serve our community. If you have
83+
a moment, please share:
84+
85+
1. Your job title (or "Student" if applicable)
86+
2. Are you primarily technical, not-so-technical, or non-technical?
87+
3. Are you in a management role or individual contributor?
88+
4. Your main interest: License Compliance, Cybersecurity, or both?
89+
5. Your experience level: Beginner, Intermediate, Advanced, or Expert?
90+
91+
Reply in this thread or DM me if you prefer. Thanks! 🙏
92+
93+
**Multi-Question Poll Using Threads**
94+
95+
.. code-block:: text
96+
97+
🎯 AboutCode User Roles - Help Us Understand You!
98+
99+
Please reply to this message with your answers (copy/paste format below):
100+
101+
Role Name: [e.g., "Open Source Compliance Manager"]
102+
Job Title: [your job title]
103+
Student/Professional: [one]
104+
Technical Level: [Technical / Not-so-technical / Non-technical]
105+
Management/Individual Contributor: [one]
106+
Interested in License Compliance? [Yes/No]
107+
Interested in Cybersecurity? [Yes/No]
108+
Experience Level: [Beginner / Intermediate / Advanced / Expert]
109+
Other Objectives: [any additional goals]
110+
111+
Thanks for helping us improve! 🚀
112+
113+
Best Practices
114+
--------------
115+
116+
**Do:**
117+
- Keep polls short and focused
118+
- Make participation easy (emoji reactions are quickest)
119+
- Follow up with results and next steps
120+
- Thank participants
121+
- Use clear, simple language
122+
- Post at times when your community is active
123+
124+
**Don't:**
125+
- Ask too many questions at once
126+
- Make polls mandatory
127+
- Use jargon or technical terms unnecessarily
128+
- Ignore responses or fail to follow up
129+
- Poll too frequently
130+
131+
Following Up
132+
-----------
133+
134+
After collecting responses:
135+
136+
1. **Thank Participants**: Acknowledge those who participated
137+
2. **Share Results**: Summarize findings (anonymized if appropriate)
138+
3. **Explain Next Steps**: Tell the community how you'll use the information
139+
4. **Update Documentation**: Incorporate findings into the user roles framework
140+
5. **Iterate**: Use feedback to refine future polls
141+
142+
Example Follow-up Message
143+
-------------------------
144+
145+
.. code-block:: text
146+
147+
📊 Thanks to everyone who participated in our user roles poll!
148+
149+
We received responses from:
150+
- 15 Compliance/Legal professionals
151+
- 12 Security Engineers
152+
- 20 Developers
153+
- 8 DevOps Engineers
154+
- 5 Students/Researchers
155+
- 3 Managers
156+
- 10 Contributors
157+
158+
This helps us understand our community better. We'll be using this information
159+
to:
160+
- Create role-specific documentation paths
161+
- Tailor our getting-started guides
162+
- Prioritize features that matter most to you
163+
164+
Stay tuned for updates! 🎉
165+
166+
Alternative: Using Google Forms or Similar
167+
------------------------------------------
168+
169+
If you need more detailed responses, consider:
170+
171+
1. **Google Forms**: Create a form and share the link in Slack
172+
2. **Typeform**: More interactive but requires account
173+
3. **SurveyMonkey**: Professional surveys with analysis tools
174+
175+
Then share the form link in #general with a brief explanation.
176+
177+
Example:
178+
179+
.. code-block:: text
180+
181+
📋 We're conducting a user roles survey to better understand our community!
182+
183+
Please take 2-3 minutes to fill out this form:
184+
[link to form]
185+
186+
Your responses help us improve documentation and prioritize features.
187+
All responses are anonymous unless you choose to share your contact info.
188+
189+
Tips for Success
190+
----------------
191+
192+
1. **Start Small**: Begin with a simple emoji reaction poll
193+
2. **Be Patient**: Not everyone will respond immediately
194+
3. **Remind Gently**: A follow-up reminder after 24-48 hours is okay
195+
4. **Make it Fun**: Use emojis and friendly language
196+
5. **Show Value**: Explain why their input matters
197+
198+
Remember: The goal is to understand your community, not to collect data for its own sake.
199+
Use the information to improve the AboutCode experience for everyone!

0 commit comments

Comments
 (0)