現在のフェーズ:
ケーススタディが公開されています。タイムラインをご覧ください。
このページでは、Google Season of Docs プロジェクトの提案に適した技術ライターを評価して選択する方法について、オープンソース 組織向けのヒントを紹介します。
はじめに
オープンソース組織は、提案されたプロジェクトに取り組む技術ライターを雇用する必要があります。組織は独自の技術ライターを調達する必要があります。Google Season of Docs に参加する組織と連携することに興味をお持ちの技術ライターは、Google Season of Docs GitHub リポジトリと、Write the Docs Slack の #season-of-docs チャンネルをご覧ください。
プロセスの開始
Google Season of Docs への参加を検討している場合は、できるだけ早く技術ライターの選定プロセスを開始することをおすすめします。
テクニカル ライターの評価
テクニカル ライターを検討している場合は、以前に作成したドキュメントの例をリクエストして、テクニカル ライティングのスキルと経験を評価することをおすすめします。
技術的なライティングのスキルと経験
テクニカル ライターのこれまでの経験を確認します。理想的には、テクニカル ライターはソフトウェア業界向けの技術ドキュメントの作成経験が必要です。Google Season of Docs の目標の 1 つは、テクニカル ライターにデベロッパー向けプロダクトに関与する機会を提供することです。そのため、プロジェクトがデベロッパー ユーザーを対象としている場合でも、ライターが API、SDK、その他のデベロッパー プラットフォームの経験を持っている必要はありません。
言語とコミュニケーション能力に重点を置く。この観点から技術ライターの過去の仕事を評価します。最も重要なのは、ユーザーが書いた内容を理解できるかどうかです。技術ライターが作成した文章を詳しく確認する場合は、句読点や表現の整合性、正しいスペル、明確な文章を探します。表現はシンプルですか?それとも複雑ですか?文は短いですか?それとも、理解しづらくなるまで長く続きますか?
ドキュメントのデザインとレイアウトに注意してください。ドキュメント サンプルの全体的なレイアウトを確認します。デザインは論理的ですか。ドキュメントまたはドキュメントセットを簡単に見つけることができますか?コンテンツの重複や明らかなギャップはありますか?
テクニカル ライターの雇用
組織は、技術ライターを雇用し、2024 年 5 月 22 日午後 6 時(UTC)までに、以下の技術ライターの雇用証明フォームに記入する必要があります。
テクニカル ライターの採用フェーズが完了しました。
採用する前に、テクニカル ライターと報酬と支払いスケジュールについて必ず話し合ってください。プロジェクトのキックオフ時の支払いなど、プロジェクトのマイルストーンに応じて、テクニカル ライターと支払いスケジュールを作成することをおすすめします。支払いスケジュールを作成する際は、支払い日(プログラム全体で 2 回のみ)と金額に注意してください。
注: 技術ライターを雇用しておらず、2024 年 5 月 22 日午後 6 時(協定世界時)までに技術ライターの雇用証明フォームを提出していない組織は、最初の支払い日に資金を受け取れません。