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

Recruit technical writer(s) to write new tutorials #729

Closed
nlhkabu opened this Issue Oct 21, 2015 · 2 comments

Comments

Projects
None yet
2 participants
@nlhkabu
Member

nlhkabu commented Oct 21, 2015

One of the key objectives of the new design is to make it much easier for beginners to understand how to install and create packages.

To facilitate this, we'd like to create two new tutorials to compliment the content already available at packaging.python.org.

The first tutorial would be a step-by-step guide for installing your first Python package. It should describe what packages are, how they work, and best practices for installation and management. The language should be friendly and simple, and no prior knowledge of packaging or Python development should be assumed.

The second would be a step-by-step guide for packaging and uploading your first Python package - here we can assume that the reader is more experienced, though the instructions should still be clear and concise.

Each tutorial should provide basic instructions and frequently link back to the full package reference for more detailed information. It is also very important that the tutorial remains consistent with this resource.

To assist in this task, we're looking for a technical writer, group of writers or developers who can work with us to write the tutorials. Ideally, we'd like to get a first version of the tutorials up within the next month, so that we can include them in our usability testing sessions (see #717).

Writers will be formally credited on the credits page of the new PyPI when it is released.

If this is something you are interested in please do not comment below - instead, contact Nicole Harris at n.harris [at] kabucreative.com

If you have ideas on what you'd like to see in the tutorials, or examples of great tutorials we can look to for inspiration, please do comment below!

@nlhkabu nlhkabu added this to the Become PyPI milestone Oct 21, 2015

@nlhkabu

This comment has been minimized.

Member

nlhkabu commented Oct 30, 2015

We've had lots of great writers volunteer to help us, so I'm going to go ahead and close this issue. Thanks to everyone who spread the word.

@nlhkabu nlhkabu closed this Oct 30, 2015

@brainwane

This comment has been minimized.

Member

brainwane commented Dec 10, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment