packaging.python.org icon indicating copy to clipboard operation
packaging.python.org copied to clipboard

Restructure this guide to be organised for intended audience, rather topics/style of content

Open pradyunsg opened this issue 3 years ago • 2 comments

Currently, this guide has a somewhat awkward content structure IMO. As it stands, I believe it is difficult to find answers to the specific questions you might care about, unless you know exactly what you're looking for.

One of the ways that we can improve this would be to pivot the guide away from organising content as "tutorials" / "guides" etc, and more toward separating content on the basis of the audience that would want to read it. A potential split of audiences based on "what you might be interested in" would be:

  • "consumer": Using Python packages
  • "author": Author/maintainer of Python software (that likely also uses Python packages)
  • "tooling-author": Author/maintainer of a tool that interacts with Python packages / index etc.
  • "contributor" : People who wish to contribute to this guide, specifically.

pradyunsg avatar Jan 12 '22 08:01 pradyunsg

To be clear, this doesn't mean we need to change the actual content or maybe even change the URLs -- it's more a matter of making sure that the user flow through the documentation is one that leads them to the right places more easily and quickly.

pradyunsg avatar Jan 12 '22 08:01 pradyunsg

@pradyunsg I'm intrigued. Could you give some concrete examples of how the current content would fit into the audience categories you described? Bonus points for linking to the current page.

bhrutledge avatar Jan 12 '22 13:01 bhrutledge