-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Expand UX documentation to include 2020 research #10745
Merged
Merged
Changes from all commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
68fbe29
scaffold UX docs
nlhkabu 0fc14a9
Update ux toc tree
nlhkabu 6ed265d
Try to get table and TOC to render
nlhkabu 411ae33
Add intro to personas page
nlhkabu 80126e1
Fix some formatting errors
nlhkabu 1b27e3b
add news file
nlhkabu 0179718
Merge branch 'main' into add-ux-docs
nlhkabu 7915302
Formatting updates
nlhkabu b2d3712
MOAR UX docs updates
nlhkabu 0e609a2
Merge branch 'main' into add-ux-docs
nlhkabu 4010d26
Update TOC tree
nlhkabu 3e152fe
Remove details of pip logo research - as incomplete
nlhkabu 531581a
Add subpages to TOC tree
nlhkabu d6a1c15
Try again with UX TOC tree
nlhkabu 3afdbe0
Remove dead image from UX docs
nlhkabu aa0bb9d
Remove duplicate links to research results
nlhkabu 980f513
Try TOC again
nlhkabu feaed52
--amend
nlhkabu 7c3205f
Clean up dead links
nlhkabu 9bc86bd
Clean up links
nlhkabu e9d8486
Fix links
nlhkabu 9dea33a
edit
nlhkabu 7b5a607
Remove codeblock for survey text
nlhkabu 597b095
formatting
nlhkabu 11e34fe
Cleanup docs content and links
nlhkabu 46aeb9c
Continue clean up
nlhkabu 5619ddf
Clean up user content
nlhkabu 4ab7a83
Fix UX guidelines formatting
nlhkabu f97ad9a
MOAR edits
nlhkabu 9ecd88e
final edits
nlhkabu b1bbbe3
improve heading strucure of results index
nlhkabu 9aaeca6
fix formatting in blockquotes
nlhkabu 6e5ebde
Merge branch 'main' into add-ux-docs
nlhkabu 558d500
Update docs/html/ux-research-design/contribute.md
pradyunsg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# How to Contribute | ||
|
||
## Participate in UX Research | ||
|
||
It is important that we hear from pip users so that we can: | ||
|
||
- Understand how pip is currently used by the Python community | ||
- Understand how pip users _need_ pip to behave | ||
- Understand how pip users _would like_ pip to behave | ||
- Understand pip’s strengths and shortcomings | ||
- Make useful design recommendations for improving pip | ||
|
||
If you are interested in participating in pip user research, please [join pip’s user panel](https://mail.python.org/mailman3/lists/pip-ux-studies.python.org/). | ||
|
||
## Test New Features | ||
|
||
You can help the team by testing new features as they are released to the community. | ||
|
||
## Report and Work on UX Issues | ||
|
||
If you believe that you have found a user experience bug in pip, or you have ideas for how pip could be made better for all users, please file an issue on the [pip issue tracker](https://github.com/pypa/pip/issues/new). | ||
|
||
You can also help improve pip’s user experience by [working on UX issues](https://github.com/pypa/pip/issues?q=is%3Aissue+is%3Aopen+label%3A%22K%3A+UX%22). Issues that are ideal for new contributors are marked with “[good first issue](https://github.com/pypa/pip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)”. Explore the | ||
[UX Guidance](guidance) if you have questions. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# UX Research & Design | ||
|
||
```{toctree} | ||
:hidden: | ||
|
||
contribute | ||
guidance | ||
research-results/index | ||
``` | ||
|
||
Welcome to pip’s UX research and design documentation. The purpose of this section of the documentation is to: | ||
|
||
- [Identify where new contributors can participate in or lead UX research and design activities](contribute) | ||
- [Share pip UX guidelines](guidance), including an introduction to User Centered Design practices, and how they can be applied to the pip project | ||
- Share [results of user research](research-results/index) that the pip team has already conducted |
291 changes: 291 additions & 0 deletions
291
docs/html/ux-research-design/research-results/about-our-users.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# How pip is used in interactive environments (i.e. CI, CD) | ||
|
||
## Problem | ||
|
||
We want to know about the contexts in which pip users use pip - interactively (i.e. typing pip commands at the command line terminal) and in an automated environment (i.e. as part of continuous software integration or continuous software development pipelines). | ||
|
||
Different contexts of use mean that users have different important and common tasks; it means when, where and how they complete these tasks are different. | ||
|
||
Each of these contexts bring different needs: interactive usage requires the right feedback/output at the right time, whereas an automated environment requires little or no feedback in the moment but detailed feedback after the task has finished. | ||
|
||
We also wanted to know what users used pip for - as part of their software development toolchain, or purely as a software installer (analogous to Ubuntu Aptitude or Mac Appstore). We also asked about their need for pip to build packages from source. | ||
|
||
## Research | ||
|
||
We created a survey and asked users to give answers to the following statements: | ||
|
||
- I use pip in an automated environment (e.g. CI/CD pipelines) | ||
- I have problems with pip in CI/CD pipelines | ||
- I use pip interactively (e.g. typing pip commands on the commandline) | ||
- I make software and use pip as part of my software development workflow | ||
- I use pip only to install and use Python packages | ||
- I need pip to build software packages from source | ||
|
||
## Results | ||
|
||
Using pip interactively makes up the majority of pip usage (91%), the majority (73%) of this usage is basic usage - to only install and use Python packages. | ||
|
||
Half (51%) of all participants used pip in an automated environment, with only 9% having issues with pip in that automated environment. This points to a good use experience for these users. | ||
|
||
71% use pip as part of their software toolchain, only 29% needing pip to build from source. | ||
|
||
These results show that the main context of use is interactive - users either writing code, installing software at the command line and we know from other research that interactive usage has its issues e.g. pip output being too verbose. | ||
|
||
While it is important to provide automated environment users with a good experience, interactive mode users are being underserved. | ||
|
||
![Answer to question - I use pip in an automated environment](https://i.imgur.com/pLHqBpN.png) | ||
|
||
![Answer to question - I use pip interactively](https://i.imgur.com/8ETVMYS.png) | ||
|
||
91% of users said they used pip interactively. This does not preclude them from automated usage. | ||
|
||
![Answer to the question - What do you use Python for?](https://i.imgur.com/ySlo2Es.png) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the mailing list still active? I notice that the link on that page for more information is broken.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is. I'll fix the link on the mailing list description. :)