介绍#

今年的 Google 文档季 (GSoD) 为我提供了与开源组织 Matplotlib 合作的机会。在初夏，我提交了关于开发 Matplotlib 入门路径的提案，目标是通过一种替代的写作方法来改进文档。

我着手通过提供现实世界中的上下文示例和编程来与用户建立更多联系。我的目的是通过解释性的方法来降低其他人开始使用 Python 库的门槛。我专注于根据一致的衍生目的和基于任务的同理心基础与用户保持一致。

该项目始于社区联谊阶段，学习文档构建和开源代码协作的基础知识。我后来为社区生成可用性测试调查并整合了调查结果。根据这些结果，我开发了两个新的文档，用于合并到 Matplotlib 存储库中：一个入门教程和一个精简的文档风格指南。

项目报告#

在今年与 Matplotlib 的文档季中，我学到了很多关于开源项目协作的知识，包括对社区进行调查、采访文档可用性测试中的主题专家，以及制作一份全面的入门指南，以通过一个倡议风格指南部分来改进入门级内容。

作为 Git 和 GitHub 的新手，我在本地机器上开始构建文档的过程中遇到了学习曲线。在使用克隆存储库并熟悉提交和拉取请求的过程中，我花费了该项目最初几周的大部分时间。但是，在经历错误和解决错误分支时，能够依靠我的导师来解决这些问题非常棒。像 Gitter、Zoom 和 HackMD 这样的平台对于保持沟通及时和简洁至关重要。我很幸运能够尽快与团队取得联系，在我遇到问题时帮助我。

在编程方面，我对 Python 和 Matplotlib 并不是完全陌生。然而，从源代码安装库并分解功能以了解核心要素帮助我更深入地理解了基本原理和术语。通过我自己使用 Python 的经验来解决所有问题，然后再从开发团队那里得到建议和建议，加速了我想要实现的想法和实现。

最初，reStructuredText 文件和 Sphinx 兼容性的新格式和标准对我来说是陌生的领域。在构建文档并阅读已经编写的内容时，我适应了利用可用的功能来编写适合 Matplotlib 新手的材料。使用嵌入的表格和代码示例，使我能够在视觉布局和导航方面更加灵活。

在项目的初始阶段，我能够将可用性测试纳入当前文档。通过联系 Twitter、Reddit 和各种 Slack 频道上的社区，我收集和整合了调查结果，这些结果有助于塑造新创建的内容的语言和重点。除了与我所在地的主题专家进行单独的信息访谈外，我还总结并分享了社区的回应。这些数据点有助于证明和支持语言和内容范围和方向的决策。

在项目结束时，我完成了我们对文档的既定期望。重点目标包括一个入门教程，用于向新用户介绍 Matplotlib 并提供上下文。此外，通过文档以及与社区的会议，我们认识到缺少风格指南的元素。虽然整个库的全面文档超出了项目的范围，但我与特色任务一起整理了一个精简版本，它作为编写 Matplotlib 文档的基础资源。

这两个部分是目前合并到 Matplotlib 存储库的拉取请求的一部分。我已经对内容进行了较小的更改，并且正在与社区一起推进该过程。

结论#

这个文档季提案最初是一个愿景，我希望与一个组织分享和努力实现，它已经成为一个充满成长和友谊的技术写作体验。我对取得的进展感到满意，并衷心感谢团队提供的领导和指导。在团队中得到欣赏和欣赏都是令人满意和有意义的。

此外，Google 团队提供的促进熟练贡献者之间合作的机会不可低估。突出这些新团队的成就提高了开源社区的标准。

详情#

致谢#

特别感谢 Emily Hsu、Joe McEwen 和 Smriti Singh 的时间和回复，还有 Matplotlib 文档季的另一位作者 Bruno Beltran 的见解和指导，以及 Matplotlib 开发团队的导师 Tim、Tom 和 Hannah 的耐心、支持和亲切，帮助像我这样的一位技术写作新手编写自己的入门指南。

关于我#

我叫 Jerome Villegas，是一名位于西雅图的技术作家。在转型到技术传播行业之前，我在教育和教育相关领域工作了几年。我的职业生涯带我去了台湾教英语和从事出版工作，然后去了纽约市，在高等教育机构工作，最后回到西雅图，在一所私立学校工作。

自从离开工作以来，我一直在华盛顿大学学习技术写作，并在学习编程的同时养家糊口。我和一位前同学一起在太平洋西北部的 UX 写作社区工作。我们主持面试环节，在会议上主持环节，并生成内容，分析 UX/技术写作的趋势和模式。

在告诉人们我的生活现状时，你可以在我的 个人网站 上找到我的作品，并在 shift J 上查看我们的最新动态。感谢您的阅读！