-
Notifications
You must be signed in to change notification settings - Fork 3.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Carry out research about pip documentation #8517
Comments
Adding this here after @pradyunsg tagged me and others in PR #9146. My first question is what questions do we want to answer with analytics? Gathering ideas on what we want to find out would help us decide. Here are my thoughts - To understand how users are using the documentationThe following data is commonly gathered in order to understand how documentation is used :
With the above data we would be able to understand how the documentation is used, decide on what pages need to be updated frequently, what pages need to be tested with users, what pages can be removed/rationalised. Helpful, but needs further thoughtThe following information would be helpful to have, tho' would need to be discussed to make sure it was implemented in the right way.
This would give us rough understanding of the language the user may speak - useful when deciding on translation.
This would be useful to understand about information layout Consent and transparencyMy opinion would be analytics would be opt-in for the documentation visitor. Explaining why we requst permission to gather the data should be communicated. It would also be important to be transparent with the community about what type of data we are gathering, and what it is being used for. I'd like to suggest discussion about making the above data public. It would be important to make sure we were not gathering IP address, granular geographic information. This would show the community what data is generated, and (I would think) be interesting for the community to see. |
For some reason I can't apply a 👍 emoji to the above comment, so I'm putting it here. |
It was a locked issue, which, doesn't allow reactions. |
I've unlocked it now. Don't remember why... 🤔 |
Research questions:
i.e. what do we want to know?
Preliminary research plan
i.e. how are we going to find all that out?
Note: We should expect some foundational insights from @ei8fdb's work on Carry out research to understand who uses pip
Some initial ideas:
Resources
i.e. where can we go for help?
People
i.e. who can help us?
@evildmp
@jdittrich
Outputs
i.e. what will we have at the end of all this?
Questions for the team
To be discussed with the pip maintainers
The text was updated successfully, but these errors were encountered: