このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Zulip Open Source Team Chat
- テクニカル ライター:
- drrosa
- プロジェクト名:
- ReadTheDocs と API ドキュメントのリファクタリング
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
ここでは 2 つの分野に絞って、並行して取り組みます。その一つは、zulip.readthedocs.io の品質を高めることで、新しい投稿者が混乱や疑念を抱くことがないようにすることです。初めての投稿から Zulip の仕組みを理解できるまでの道筋が明確で簡潔なのが理想的です。また、追加のエンドポイントを文書化するプロセスを理解しやすくするために、zulipchat.com/api、api.md、openapi.md に取り組む予定です。どちらの部分にも、コンテンツの更新 / 簡素化、記事の整理、不足しているデベロッパー向けドキュメントの追加、コードの記述とテストが含まれる可能性があります。
このプロジェクトは 4 つのフェーズで構成されます。最初のフェーズでは、小規模な慣れ親しんだプロジェクト、準備ツール、現在のドキュメントのニーズについてのより深い理解を行います。第 2 フェーズの目的は、この秋に Zulip の目標に沿って仕事を構造化、特定、優先順位付けすることです。次に、プロジェクトの実装フェーズに移ります。メンターや Zulip のデベロッパー コミュニティの皆さんとやり取りしてフィードバックを求めます。最後のフェーズは、振り返り、必要な箇所の修正、プロジェクト レポートの作成です。
他の人が取り組んでいる作業の結果として、コア デベロッパーによる決定を含め、一部の優先事項やタスクは、勤務時間中に変化する可能性があります。私は、このような変化にうまく適応する方法について学ぶことが、GSoD を成功に導くうえで不可欠なものになると私は考えています。ある時点で、提案されたアイデアを後で見ることを延期することもできます。一般的には、自分の仕事が Zulip のオープンソース プロジェクトの全体的な成功に価値をもたらすようにすることに注力します。