Skip to content

Commit 85519c3

Browse files
committed
Merge pull request pypa#8807 from pypa/add-ux-docs
Add ux docs to pip documentation
1 parent 045ddd9 commit 85519c3

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

docs/html/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Please take a look at our documentation for how to install and use pip:
1414
user_guide
1515
reference/index
1616
development/index
17+
ux_research_design
1718
news
1819

1920
In 2020, we're working on improvements to the heart of pip. Please `learn more and take our survey`_ to help us do it right.

docs/html/ux_research_design.rst

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
====================
2+
UX Research & Design
3+
====================
4+
5+
Over the course of 2020, the pip team has been working on improving pip's user
6+
experience.
7+
8+
Currently, our focus is on:
9+
10+
1. `Understanding who uses pip`_
11+
2. `Understanding how pip compares to other package managers, and how pip supports other Python packaging tools`_
12+
3. `Understanding how pip's functionality is used, and how it could be improved`_
13+
4. `Understanding how pip's documentation is used, and how it could be improved`_
14+
15+
You can read the `overall plan`_ and the `mid-year update`_ to learn more about
16+
our work.
17+
18+
How to contribute
19+
-----------------
20+
21+
Participate in UX research
22+
==========================
23+
24+
It is important that we hear from pip users so that we can:
25+
26+
- Understand how pip is currently used by the Python community
27+
- Understand how pip users *need* pip to behave
28+
- Understand how pip users *would like* pip to behave
29+
- Understand pip's strengths and shortcomings
30+
- Make useful design recommendations for improving pip
31+
32+
If you are interested in participating in pip user research, please
33+
`join pip's user panel`_.
34+
You can `read more information about the user panel here`_.
35+
36+
We are also looking for users to:
37+
38+
- `Give us feedback about pip's new resolver`_
39+
- `Tell us how pip should handle conflicts with already installed packages when updating other packages`_
40+
41+
Report UX issues
42+
================
43+
44+
If you believe that you have found a user experience bug in pip, or you have
45+
ideas for how pip could be made better for all users, you please file an issue
46+
on the `pip issue tracker`_.
47+
48+
Work on UX issues
49+
=================
50+
51+
You can help improve pip's user experience by `working on UX issues`_.
52+
Issues that are ideal for new contributors are marked with "good first issue".
53+
54+
Test new features
55+
=================
56+
57+
You can help the team by testing new features as they are released to the
58+
community. Currently, we are looking for users to
59+
`test pip's new dependency resolver`_.
60+
61+
Next steps
62+
----------
63+
64+
In the coming months we will extend this documentation to include:
65+
66+
1. Summaries of our user research, including recommendations for how to improve pip
67+
2. Tools for the pip team to continue to practice user centered design (e.g. user personas, etc.)
68+
69+
.. _Understanding who uses pip: https://github.com/pypa/pip/issues/8518
70+
.. _Understanding how pip compares to other package managers, and how pip supports other Python packaging tools: https://github.com/pypa/pip/issues/8515
71+
.. _Understanding how pip's functionality is used, and how it could be improved: https://github.com/pypa/pip/issues/8516
72+
.. _Understanding how pip's documentation is used, and how it could be improved: https://github.com/pypa/pip/issues/8517
73+
.. _overall plan: https://wiki.python.org/psf/Pip2020DonorFundedRoadmap
74+
.. _mid-year update: http://pyfound.blogspot.com/2020/07/pip-team-midyear-report.html
75+
.. _join pip's user panel: https://tools.simplysecure.org/survey/index.php?r=survey/index&sid=827389&lang=en
76+
.. _read more information about the user panel here: https://bit.ly/pip-ux-studies
77+
.. _Give us feedback about pip's new resolver: https://tools.simplysecure.org/survey/index.php?r=survey/index&sid=989272&lang=en
78+
.. _Tell us how pip should handle conflicts with already installed packages when updating other packages: https://docs.google.com/forms/d/1KtejgZnK-6NPTmAJ-7aWox4iktcezQauW-Mh3gbnydQ/edit
79+
.. _pip issue tracker: https://github.com/pypa/pip/issues/new
80+
.. _working on UX issues: https://github.com/pypa/pip/issues?q=is%3Aissue+is%3Aopen+label%3A%22K%3A+UX%22
81+
.. _test pip's new dependency resolver: https://pip.pypa.io/en/latest/user_guide/#changes-to-the-pip-dependency-resolver-in-20-2-2020

news/8807.doc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add ux documentation

0 commit comments

Comments
 (0)