本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Zulip 开源团队聊天
- 技术文档工程师：
- drrosa
- 项目名称：
- 重构了 ReadTheDocs 和 API 文档
- 项目时长：
- 标准时长（3 个月）
Project description
我将重点关注两个方面，并并行处理它们。其中一项举措是提高 zulip.readthedocs.io 的质量，以便新的贡献者在使用过程中减少混淆和疑虑。理想情况下，从首次贡献到熟悉 Zulip 的工作原理，用户将获得清晰简洁的路径。我还计划改进 zulipchat.com/api、api.md 和 openapi.md，以便更轻松地记录其他端点。这两个部分都可能涉及更新/简化内容、整理文章、添加缺失的开发者文档，以及编写/测试代码。
该项目将分为四个阶段。第一阶段将包括小型熟悉项目、准备工具，以及更好地了解当前的文档需求。第二阶段的目的是根据 Zulip 这个秋季的目标来安排工作、指定工作并确定工作优先级。然后，我将进入项目的实施阶段。我会与导师和 Zulip 的其他开发者社区成员反复沟通，以获取反馈。最后一个阶段是回顾、根据需要进行修改并撰写项目报告。
我怀疑，在整个工作期间，由于其他人的任务，一些优先事项和任务可能会发生变化，包括核心开发者做出的决定。我认为，要想获得成功的 GSoD 体验，就必须学会如何适应这些变化。在某些情况下，推迟提出的想法可能很有必要。一般来说，我将专注于确保我的工作能为 Zulip 开源项目的整体成功带来价值。