本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Zulip 开源团队聊天
- 技术文档工程师：
- drrosa
- 项目名称：
- 重构 ReadTheDocs 和 API 文档
- 项目时长：
- 标准时长（3 个月）
Project description
我将重点关注两个方面，并同时开展这两方面的工作。其中之一是提高 zulip.readthedocs.io 的质量，使新贡献者在使用过程中遇到的困惑和疑问。理想情况下，从首次做贡献到熟悉 Zulip 运作方式，最终的实验结果是一条简明扼要的过程。此外，我还计划开发 zulipchat.com/api、api.md 和 openapi.md，让记录其他端点的过程更容易理解。这两个部分都可能涉及更新/简化内容、整理文章、添加缺失的开发者文档以及编写/测试代码。
该项目包括四个阶段。第一阶段包括小规模的熟悉项目、准备工具以及更好地了解当前文档需求。第二阶段的目的是根据 Zulip 今年秋季的目标来安排工作的结构、说明工作的优先级和确定工作的优先级。然后，我将进入项目的实施阶段。我将与导师以及 Zulip 开发者社区的其他成员反复沟通，以获得反馈。最后阶段是回顾、根据需要进行修改并撰写项目报告。
我怀疑，在整个工作期间，由于其他人的工作（包括核心开发者所做的决策），一些优先事项和任务可能会发生变化。我相信，要想获得成功的 GSoD 体验，学习如何有效地适应此类变化是必不可少的。在某些情况下，将建议的想法推迟到晚些时候是合理的。一般来说，我的工作重点是确保自己的工作能为 Zulip 开源项目的整体成功带来价值。