Django 项目

本页面包含 Google 文档季接受的技术写作项目的详细信息。

项目摘要

开源组织：

Django

技术文档工程师：

Gabbyprecious

项目名称：

重写了贡献指南，使其更易于使用和浏览

项目时长：

标准时长（3 个月）

Project description

ABSTRACT

与所有其他文档一样，Django 的贡献指南旨在指导用户（在本例中为开源贡献者）了解如何以及在哪些方面贡献力量，以便让 Django 变得更好、更可持续。

我们始终需要编写文档，尤其是对社区和 Django 本身有重大影响的文档。

今年，Django 参与 Google 文档之夏活动的目标是，让贡献指南更易于访问，内容更通俗易懂，让贡献者感到宾至如归。这一目标至关重要，因为它鼓励贡献者（我本人就是其中之一）开始为这个出色的框架做出贡献。

当前状态

您可以在此处找到当前阶段的文档，但它并不像指南那样实用，因为内容太多且结构不清晰，导致人们对 Django 中的贡献了解不深，也不欢迎新贡献者。

项目目标

我在论坛上与我的导师 Carlton Gibson 讨论了有关文档的建议，他认为这些建议有助于解决当前文档存在的大量问题。以下是我计划通过重构文档来实现的目标： 重构文档 添加各部分的“应做”和“不应做”事项 为“请求和制作功能”等琐碎部分创建单独的页面 精简文档并直奔主题 提供字词术语表 根据新指南构建内部索引 撰写更贴近用户的文档 将内容划分为两个主要部分（新手贡献者和高级贡献者部分） 为新手技术文档撰写者/贡献者构建指南和样式，以确保文档保持最新状态并遵循标准。

目前的文档已面向高级贡献者，不适合新手贡献者和 Django 新手贡献者，因此我们为新手贡献者准备了一些额外的内容： 为不同贡献者（技术文档撰写者、设计师和开发者）提供指导的部分 记录新手问题和可解决的简单问题的页面。 从当前文档中取出几个部分，进行重写，然后添加到“新手”部分。 用于解释高级部分中使用的要点或字词的部分。

时间轴

下面将详细介绍我打算如何使用 Google 提供的日历来实现上述项目目标。

社区互动周（8 月 17 日至 9 月 13 日） 与社区进行更多互动 继续为文档做出贡献 从贡献者那里获得更多建议 更多地研究当前文档和预期工具 第 1 周至第 4 周 开始根据等级对文档进行分区 创建文档的初学者部分 第 4 周至第 6 周 整理“应做”和“不应做”清单 编写分区“应做”和“不应做”清单 为各部分创建其他页面 第 7 周至第 9 周 重写并将当前文档移至“高级贡献者指南” 缩减文档内容 第 10 周至第 12 周 准备术语表 将内部索引更新为新文档 为新加入的技术文案撰写者/贡献者创建指南和样式

工具

Sphinx - 当前文档的当前工具。 请参阅文档。

为什么要开展此项目？

我坚信，编写出优质的文档和文章，可以让世界各地的所有人都能受益。除此之外，我还喜欢 Django 和开源。作为一名初学者，我一直想为 Django 做出贡献，我认为这是为自己喜爱的工具做出贡献的绝佳方式，同时还可以熟悉代码库，以便作为开发者（和技术文档撰写者）做出更多贡献。与与我的观点相符且对我的整个职业生涯有很大帮助的组织合作，将会是一件愉快而美好的事。

为什么我适合参与此项目？

我认为自己符合以下条件，因此是合适的候选人： 我一直在为 Django 做出贡献，撰写文章来帮助初学者更好地理解 Django 的概念。 我是一名开发者，并且很期待为 Django 做贡献，我了解其他开发者的需求，以及如何为他们提供良好的文档记录。 我是一个团队合作者，在导师 Carlton Gibson 的监督下，我会更加努力地工作。