現在のフェーズ:
2019 シーズン オブ ドキュメント プログラムは 2020 年 3 月 6 日に終了しました。タイムラインをご覧ください。
このページには、オープンソース団体を対象とした、テクニカル ライティング プロジェクトの提案の評価方法と、ドキュメントのシーズンでメンタリングするプロジェクトを選択する方法についてのガイドラインが記載されています。
はじめに
テクニカル ライターは、選択したオープンソース組織でプロジェクトに取り組むため、シーズンの Google ドキュメントに関する提案を提出します。Google のプログラム管理者は、評価とプロジェクト選択のために提案をオープンソース組織に転送します。必要な手順の詳細については、組織管理者のガイドをご覧ください。
テクニカル ライターの提案の評価
テクニカル ライティングのスキルと経験
テクニカル ライターのこれまでの経験を確認する。テクニカル ライターの提案には、最新のテクニカル ライティング体験に関する情報が含まれています。申請者には、ソフトウェア業界の技術ドキュメントの作成経験があることが理想的です。「ドキュメント シーズン」の目標のひとつは、テクニカル ライターがデベロッパー向けのプロダクトに関わる機会を提供することです。そのため、開発者が対象プロジェクトであっても、ライターが API、SDK、またはその他のデベロッパー プラットフォームの経験を持っていることはそれほど重要ではありません。
言語スキルとコミュニケーション スキルに注力します。 この視点からテクニカル ライターの提案を評価します。最も重要なのは、相手が何を書いたか理解できているかということです。メンターの役割は、オープンソースのプロセス、ツール、コードでテクニカル ライターを手助けすることです。作成されたドキュメントのテキストも確認する必要はありません。提案の言語を詳細にレビューする場合は、句読点とフレーズの一貫性、スペルの修正、明確な表現に注意してください。言い回しは簡単ですか、それとも複雑ですか？センテンスは短いか、理解しづらくなるまで継続しているか？
ドキュメントの設計とレイアウトに注意を払う。提案の一環として、テクニカル ライターは作成したドキュメントの例を提供できます。ドキュメント サンプルの全体的なレイアウトを確認します。デザインは論理的ですか？ドキュメントやドキュメント セットのやり方を簡単に見つけられるか。コンテンツの重複や明らかなギャップの有無
提案
提案が要件に合っていることを確認します。 この提案は、今年のドキュメント シーズンに応募したプロジェクトのアイデアのいずれかに関連していますか。テクニカル ライターが新しいアイデアを提案した場合は、その提案がオープンソース プロジェクトのニーズに適していることと、テクニカル ライターが提案したプロジェクトの目標を達成するための適切な人材がいることを確認します。
熱意と徹底したこだわりを探す。 この提案は、テクニカル ライターがプロジェクトに興味を持っていることを示していますか。調査フェーズで組織と協議するか、プロジェクトの目標達成方法について独自の意見を追加するかのいずれかで、彼らが提案に工夫を凝らしたかどうかを検討します。
よくある質問
提出するプロジェクトの数はどのように決定されるのですか？
1 つまたは 2 つのプロジェクトに取り組みます。組織にそれ以上の能力がある場合はさらに提出できます。テクニカル ライター プロジェクトごとに、そのプロジェクトのみをメンターとして扱うメンターが 1 名以上（できれば 2 名）必要です。
シーズンの Google ドキュメントのスロット割り当ての仕組みに関する情報を確認する。
採用するテクニカル ライティングの提案はどのように選択すればよいですか？
受け取ったテクニカル ライターの提案の中から最適なものを選択してください。つまり、要件に最も適し、上記の評価ガイドラインに最も合致する提案を選択します。
選択した提案書を送信するために必要なフォームはどこにあるか？
組織管理者ガイドをご覧ください。