Open
Description
Research questions:
i.e. what do we want to know?
- When pip users have a problem or experience an error, what do they do? (note: crossover with Carry out research to understand who uses pip #8518)
- When pip users want to accomplish a specific task, what do they do? (note: crossover with Carry out research to understand who uses pip #8518)
- How do users use pip's current documentation?
- Does it provide good orientation / is the structure clear?
- Does the documentation look "official"?
- Does it look trustworthy?
- Does it look like an "official" Python property?
- Do users understand the terminology?
- How do users distinguish between pip documentation and other documentation in the packaging ecosystem (e.g. packaging.python.org, PyPI help page, etc.)?
- How do pip/packaging maintainers think about documentation and write documentation?
- Is it obvious where documentation should go?
- What ideas do they have about improving the docs?
- Are there (written or unwritten) documentation standards?
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:
- Investigate if we can use analytics to draw conclusions about pip's docs (e.g. time on page, etc.)
- Gather feedback while users are on pip's documentation (e.g. allow users to send feedback in real time)
- Conduct user interviews with a range of pip users
- Ask users to participate in journal studies
- Collect feedback from the community via surveys
- Conduct interviews with packaging maintainers
Resources
i.e. where can we go for help?
- Divio documentation system: breaks down documentation into 4 segments: tutorials, how-to guides, technical reference and explanation
- Google technical writing course
- Write the docs resources
- How to test the usability of documents
- Information architecture basics
People
i.e. who can help us?
-
- Review research plan
- Review outputs / recommendations (see below)
- Periodic involvement as docs are rebuilt
-
- Assist in collecting and analysing data
- Note: Jan has an academic interest in how people understand documentation (PHD subject)
Outputs
i.e. what will we have at the end of all this?
- Documentation about pip's documentation - how it is used, it's shortcomings, etc.
- Strategy for how to restructure / rewrite pip's documentation
- Guide for how to contribute to pip's documentation, outlining:
- documentation best practices / principles
- copywriting styleguide / glossary of terms
Questions for the team
To be discussed with the pip maintainers
- Which research questions (from the list above) are most important?
- What is the best way to involve the team when working out the strategy for restructuring / rewriting the docs?
- Should we run a workshop on this?
- Should UX periodically present our ideas for feedback?
- How often?
- What channel? (team meeting, HackMD review, GitHub, other?)
- How can we put in place the resources / people to execute the strategy?
- Is it within the scope of the currently funded work?
- If not, how can we move forward on this?