This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- NumPy
- Technical writer:
- bonn0062
- Project name:
- Making "The Basics" a Little More Basic: Improving the Introductory NumPy Sections
- Project length:
- Standard length (3 months)
Project description
As a massive fan of both NumPy and SciPy, I would love to have the opportunity to work with the introductory materials at numpy.org to make them more accessible for beginners. While these materials are focused and to-the-point, I think that significant room exists for making the content feel more beginner-friendly. I would be excited to either improve the existing introductory content at NumPy.org or create separate pages that would be specifically focused on people who are new to Python and NumPy.
This project will involve taking the existing language in the introductory NumPy materials and translating it into language that people without strong technical backgrounds can understand. It would make sense to incorporate more images and graphics, as well as more links to examples of projects that have been built with NumPy. (An enormous number of the most incredible ideas being developed right now utilize NumPy, so the only difficulty there will be narrowing down the options.)
There are a lot of benefits to helping people understand what NumPy can really do. Whether you'd prefer to create a separate space for this beginner-focused material or to build it into the existing documentation, I think that this approach can only benefit NumPy. The number of people who are entering fields like science, engineering, data science, machine learning, and artificial intelligence is increasing exponentially. NumPy is the backbone of all of these fields. Letting beginners and decision makers understand from day one what NumPy is and what it can really do will help you stay that way long into the future.