このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- OpenJS Foundation
- テクニカル ライター:
- ライト
- プロジェクト名:
- Fastify のドキュメントを全面的に改訂
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
2 つの分野に焦点を当てます。その 1 つはスタイルガイドの作成です。これには、fastify.io の現在のドキュメントの再構成も含まれ、新規ユーザーがシームレスに理解できるようにします。もう 1 つは、fastify へのコントリビューション コンテンツの品質を向上させ、新しいコントリビューターが混乱や疑問に直面しないようにすることです。初めての投稿から、Fastify の仕組みに慣れるまでの、明確かつ簡潔な結果が得られるのが理想的です。
このプロジェクトは、次の 4 つのフェーズで実施されます。まず、利用可能な包括的なツールに慣れ、現在のドキュメントのニーズを把握します。第 2 フェーズの目標は、この GSoD における Fastify の目標のコンテキストを構造化し、指定して優先順位を付けることです。その後、実装フェーズを開始します。このフェーズでは、メンターや Fastify のデベロッパー コミュニティとフィードバックをやり取りします。最後のステップでは、必要に応じてレビューと修正を行い、プロジェクト レポートを作成します。
このオープンソース プロジェクトの全体的な成功に貢献できるよう努めます。