Skip to content

Commit 5da6b2f

Browse files
nlhkabupradyunsgpfmoore
authored
Expand UX documentation to include 2020 research (#10745)
Co-authored-by: Pradyun Gedam <[email protected]> Co-authored-by: Paul Moore <[email protected]>
1 parent 551e822 commit 5da6b2f

18 files changed

+2550
-82
lines changed

docs/html/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ cli/index
2323
:hidden:
2424
2525
development/index
26-
ux_research_design
26+
ux-research-design/index
2727
news
2828
Code of Conduct <https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md>
2929
GitHub <https://github.com/pypa/pip>
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# How to Contribute
2+
3+
## Participate in UX Research
4+
5+
It is important that we hear from pip users so that we can:
6+
7+
- Understand how pip is currently used by the Python community
8+
- Understand how pip users _need_ pip to behave
9+
- Understand how pip users _would like_ pip to behave
10+
- Understand pip’s strengths and shortcomings
11+
- Make useful design recommendations for improving pip
12+
13+
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/).
14+
15+
## Test New Features
16+
17+
You can help the team by testing new features as they are released to the community.
18+
19+
## Report and Work on UX Issues
20+
21+
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).
22+
23+
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
24+
[UX Guidance](guidance) if you have questions.

docs/html/ux-research-design/guidance.md

Lines changed: 412 additions & 0 deletions
Large diffs are not rendered by default.

docs/html/ux-research-design/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# UX Research & Design
2+
3+
```{toctree}
4+
:hidden:
5+
6+
contribute
7+
guidance
8+
research-results/index
9+
```
10+
11+
Welcome to pip’s UX research and design documentation. The purpose of this section of the documentation is to:
12+
13+
- [Identify where new contributors can participate in or lead UX research and design activities](contribute)
14+
- [Share pip UX guidelines](guidance), including an introduction to User Centered Design practices, and how they can be applied to the pip project
15+
- Share [results of user research](research-results/index) that the pip team has already conducted

docs/html/ux-research-design/research-results/about-our-users.md

Lines changed: 291 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# How pip is used in interactive environments (i.e. CI, CD)
2+
3+
## Problem
4+
5+
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).
6+
7+
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.
8+
9+
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.
10+
11+
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.
12+
13+
## Research
14+
15+
We created a survey and asked users to give answers to the following statements:
16+
17+
- I use pip in an automated environment (e.g. CI/CD pipelines)
18+
- I have problems with pip in CI/CD pipelines
19+
- I use pip interactively (e.g. typing pip commands on the commandline)
20+
- I make software and use pip as part of my software development workflow
21+
- I use pip only to install and use Python packages
22+
- I need pip to build software packages from source
23+
24+
## Results
25+
26+
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.
27+
28+
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.
29+
30+
71% use pip as part of their software toolchain, only 29% needing pip to build from source.
31+
32+
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.
33+
34+
While it is important to provide automated environment users with a good experience, interactive mode users are being underserved.
35+
36+
![Answer to question - I use pip in an automated environment](https://i.imgur.com/pLHqBpN.png)
37+
38+
![Answer to question - I use pip interactively](https://i.imgur.com/8ETVMYS.png)
39+
40+
91% of users said they used pip interactively. This does not preclude them from automated usage.
41+
42+
![Answer to the question - What do you use Python for?](https://i.imgur.com/ySlo2Es.png)

0 commit comments

Comments
 (0)