NumPy project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- NumPy
- Technical writer:
- kubedoc
- Project name:
- High level restructuring and end user focus
- Project length:
- Standard length (3 months)
Project description
- Proposal:
- Create and improve high-level documentation—Tutorials and How-Tos—covering topics that are missing from the official documentation.
- Creating a new ""Explanations"" section, organizing the content currently scattered through the reference documentation.
- Goal: provide ways to guide users to the parts of the documentation most relevant to them.
- Outcome: improve high-level documentation for new Pythonistas as well as experienced scientists and programmers.
- Please note that I have experience using NumPy in the context of numerical computing and machine learning (with Pandas, PyTorch, TensorFlow, and JAX).
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["This project focuses on improving NumPy's documentation by creating high-level tutorials, how-to guides, and explanations for both new and experienced users."],["The project aims to restructure and reorganize existing content to be more user-friendly and accessible."],["Led by technical writer 'kubedoc', this Google Season of Docs project will be completed over three months."]]],["The NumPy organization accepted a Google Season of Docs project focused on improving high-level documentation. The project will create and enhance Tutorials and How-Tos, and establish a new \"Explanations\" section. The aim is to organize scattered content and guide users to relevant documentation. This will improve the experience for both new and experienced users in Python and scientific computing. The technical writer has prior experience using NumPy with other relevant libraries. The project will last three months.\n"]]
