本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Django
- 技术文档工程师：
- Gabbyprecious
- 项目名称：
- 重写了贡献指南，使其更加人性化且易于导航
- 项目时长：
- 标准时长（3 个月）
Project description
摘要
与所有其他文档一样，Django 贡献指南的目标是，在本例中为用户和开源贡献者提供指导，让他们了解如何以及在何处为 Django 变得更好、更具可持续性做出贡献。
我们总是需要制作文档，尤其是对社区和 Django 本身极大影响的文档。
Django 今年的 Google 文档夏季计划的目标是减少贡献指南对贡献者的压倒性、无障碍性和热情。这是一个至关重要的目标，因为它可以鼓励贡献者，我本人也正值，开始为这一出色的框架做贡献。
当前状态
此处提供的文档的当前阶段不太起到指导作用，因为它太丰富了，结构不合理，并且会导致对 Django 中的贡献的了解较少，并且不欢迎新的贡献者。
项目目标
我在论坛中与我的导师 Carlton Gibson 讨论了我对文档的建议，他同意这些建议有助于解决当前文档中的巨大问题。我计划在调整文档结构时实现以下目标： 重新调整文档结构 添加分部分的正确做法和错误做法 为简单的部分创建单个页面，例如请求和开发功能 简明扼要的文档 词汇表 内部索引按照新指南构建 编写更能引起共鸣的文档 编写更能引起共鸣的文档 将内容细分为两部分内容（初级贡献者/文档）和高级贡献者
当前的文档已面向高级贡献者，并且不会为刚开始接触开源和 Django 新手和新手的贡献者提供机会，以下是一些面向初学者的其他内容： 用于指导不同贡献者（技术文档作者、设计人员和开发者）的部分 该页面记录了计时器问题以及可以解决的简单问题。 选取当前文档中的几个部分，重写并添加到“新手”部分。 用于说明高级部分所用要点或字词的部分。
时间表
我想要如何使用 Google 提供的日历完成上面列出的项目目标，下面我将进行详细介绍。
社区凝聚周（8 月 17 日 - 9 月 13 日） 减少新加入的 Google 文档风格/文档 7 继续为文档做贡献 继续为文档做贡献 获取更多关于当前文档和预期工具的建议 第 1 周 - 第 4 周 开始按等级划分文档 创建文档新手部分 创建文档新手部分 创建文档第 4 - 6 周的注意事项部分和注意事项部分
工具
Sphinx - 用于当前文档的当前工具。 阅读文档。
为何推出此项目？
我坚信，编写出优秀的文档和文章让世界各地的每个人都能参与进来。除此之外，我还是 Django 和整个开源的爱好者。作为初学者，我一直有意为 Django 做贡献。我认为这是为我最喜爱的工具贡献代码的一种绝佳方式，同时我也熟悉代码库，以开发者（和技术编写者）的身份提供更多贡献。与我的观点相契合的组织合作，是我整个职业生涯中不可或缺的工具，能够合作，我将非常愉悦又美妙。
为什么说我是这个项目的合适人选？
根据以下帐号，我认为自己是正确的人： 我一直在撰写文章，帮助初学者更多地了解 Django 的概念，从而为 Django 做出贡献。作为一名开发者并期待为 Django 做出贡献，我了解其他开发者的需求，以及如何为他们编写良好的文档记录。我是一个团队合作人，在导师 Carlton Gibson 的监督下可以很好地完成工作。