このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Zulip オープンソース チーム チャット
- テクニカル ライター:
- drrosa
- プロジェクト名:
- ReadTheDocs と API ドキュメントのリファクタリング
- プロジェクト期間:
- 標準の期間（3 か月）
プロジェクトの説明
2 つの分野に焦点を当てて、並行して取り組みます。そのうちの 1 つは、zulip.readthedocs.io の品質を改善して、新しい投稿者が混乱や疑問に遭遇することが少なくなるようにすることです。理想的には、初めて投稿するところから Zulip の仕組みに慣れるまで、明確で簡潔なパスが作成されるようにします。また、zulipchat.com/api、api.md、openapi.md にも取り組み、追加のエンドポイントのドキュメント化プロセスをわかりやすくする予定です。どちらの部分にも、コンテンツの更新/簡素化、記事の整理、不足しているデベロッパー向けドキュメントの追加、コードの記述/テストが含まれます。
このプロジェクトは 4 つのフェーズで構成されます。最初のフェーズでは、小さな慣らしプロジェクト、準備ツール、現在のドキュメントのニーズをより深く理解することなどが含まれます。第 2 フェーズでは、この秋の Zulip の目標に基づいて、作業の構造化、仕様化、優先順位付けを行います。次に、プロジェクトの実装フェーズに進みます。メンターや Zulip のデベロッパー コミュニティの他のメンバーとフィードバックをやり取りします。最後のフェーズでは、振り返り、必要に応じて修正し、プロジェクト レポートを作成します。
他のすべてのメンバーが取り組んでいる作業（コア デベロッパーによる決定を含む）の結果として、一部の優先順位とタスクが作業期間中に変更される可能性があります。このような変化にうまく適応する方法について学ぶことは、GSoD を成功に導くうえで不可欠な側面です。ある時点で、提案されたアイデアを後で検討するために延期した方がよい場合もあります。一般的に、私の仕事は、Zulip オープンソース プロジェクトの全体的な成功に価値をもたらすことに重点を置いています。