テクニカル ライター ガイド

現在のフェーズ:
2019 シーズン オブ ドキュメント プログラムは 2020 年 3 月 6 日に終了しました。タイムラインをご覧ください。

このページでは、Google ドキュメントのシーズンに参加するテクニカル ライター向けのガイドを紹介します。

はじめに

ドキュメントのシーズンへようこそこのガイドでは、Google ドキュメント シーズンへの参加と、プログラムの各フェーズで実施すべきアクティビティについて説明します。

「ドキュメント シーズン」への参加要件

テクニカル ライターとして Google ドキュメントのシーズンに参加するには、次の要件を満たしている必要があります。

  • 登録時点で 18 歳以上であること。
  • 職務の説明と作業サンプルを提出することで、技術的な文書に関する以前の経験を実証できること
  • プログラム期間中、居住国で働く資格がある。
  • 現在米国による禁輸措置されていない国の居住者である。 米国財務省の制裁プログラムと国情報をご覧ください。

テクニカル ライター向け用語の全文をご覧ください。

オープンソースのメンター

ドキュメントのメンターは、必ずしもテクニカル ライターではなく、テクニカル コミュニケーションの経験がほとんどない場合があります。チームメンバーはオープンソース組織のメンバーで、優れたドキュメントの価値を知っており、オープンソースのプロセスとツールの経験があります。

あなたとメンターの関係はコラボレーションです。ドキュメントに関する経験とスキルをオープンソース団体にもたらします。メンターはオープンソースとコードの知識を提供してくれます。協力して技術ドキュメントを作成し、オープンソース プロジェクトのプロセスを改善できます。

プログラムのお知らせと組織の申請フェーズ

「ドキュメント シーズン」の発表日は 2019 年 3 月 11 日です。ご関心をお持ちのオープンソース団体は、2019 年 4 月 2 日から 2019 年 4 月 23 日までの間に、ドキュメント シーズンへの参加を申し込むことができます。Google プログラム管理者は、成功した組織のリストを 2019 年 4 月 30 日に公表しています。

プログラムのお知らせから参加オープンソース団体の公開までの期間は、ニュースにご注意ください。このページに戻ると、ウェブ上のブログ投稿やその他のニュースをご覧いただけます。オープンソース組織の中には、組織の応募段階でもアイデアを共有するものがあります。

また、Google ドキュメントのシーズンについて、またこのプログラムに関心を寄せる理由についても広めてください。図やアイデアについては、宣伝資料をご覧ください。

テクニカル ライターの調査フェーズ

テクニカル ライターの調査フェーズは 2019 年 4 月 30 日から 5 月 28 日までです。この期間中、参加組織とそのプロジェクトのアイデアのリストを探索できます。

興味のあるプロジェクトが 1 つ以上見つかったら、関連するオープンソース組織に直接問い合わせて、プロジェクトのアイデアについて話し合う必要があります。

このフェーズでのテクニカル ライターとしてのタスク

参加しているオープンソース組織のリストと、その組織のプロジェクトのアイデアをご覧ください。

一覧から、連携するオープンソース組織を見つけてください。各組織が提案したテクニカル ライティング プロジェクトを確認し、どのプロジェクトが自分に適しているかを判断します。複数の組織に応募できます。Google ドキュメントのシーズンのこの段階では、複数のオプションを検討することをおすすめします。最終的な選定プロセスでは、テクニカル ライター 1 人につき 1 つのプロジェクトのみを採用します。

参加しているオープンソース団体

プロジェクトのアイデアについてオープンソース団体と話し合います。

プロジェクトのアイデアについて、どの参加組織とも話し合うことができます。連絡するには、参加組織のリストに表示されている組織のメールアドレスを使用します。早期のディスカッションは、テクニカル ライターの応募段階で Google のプログラム管理者に送信する優れたプロジェクト提案を作成する際に役立ちます。組織が提案したアイデアリストから、最初のプロジェクトのアイデアが見つかる場合もあります。独自のアイデアも提案できます。

参加しているオープンソース団体

テクニカル ライティング プロジェクトのアイデア

テクニカル ライターの申請フェーズ

テクニカル ライターの応募フェーズは 2019 年 5 月 29 日から 2019 年 6 月 28 日まで実施されます。この期間中、ドキュメント シーズンへの参加を申し込むことができます。Google プログラム管理者は、アプリケーションから関連する詳細情報を、デベロッパーが選択したオープンソース組織に転送します。オープンソースの組織管理者とメンターは、メンターするプロジェクトを選択します。

この段階でのテクニカル ライターとして申請するタスク

Google ドキュメントのシーズンに参加するには、応募フォームを送信してください。

2019 年 6 月 28 日までに、「ドキュメントのシーズン」にお申し込みください。

アプリケーションの作成

2019 シーズンの Google ドキュメント テクニカル ライターの募集は終了しました。

コミュニティの絆を深めるフェーズ

コミュニティの絆を深めるフェーズは、2019 年 8 月 7 日から 9 月 1 日までです。この期間中、オープンソースのメンターは、オープンソースのプロジェクトやコミュニティになじめるようサポートします。

このフェーズでのテクニカル ライターとしてのタスク

通信チャネルを設定する。

連携することを選んだオープンソース組織のメンターに連絡します。メンターや組織管理者と直接やり取りできる信頼性の高い手段を確保してください。組織管理者は、組織の Google ドキュメントに関する主要な連絡先として機能するオープンソース組織のメンバーです。

お客様の責任

メンターの責任

テクニカル ライターと連携するためのメンター向けガイド

オープンソースのプロジェクトやコミュニティに参加する。

オープンソース組織が使用しているツールやプロセスについてメンターに質問します。オープンソース コミュニティのメーリング リスト、チャット、Slack チャンネル、その他の共有コミュニケーション チャネルで自己紹介します。

商品全体を理解する。

近いうちに文書化するプロダクトについて、メンターに(特に概念的に)説明してもらいます。ドキュメントの対象読者について詳しく説明してください。

目標と今後の見通しを設定します。

メンターと協力して、テクニカル ライティング プロジェクトの目標を絞り込み、双方に期待値を設定します。これらの目標と期待値を今すぐ設定することは、プロジェクトの成功を確実にする優れた方法です。

ドキュメント開発フェーズ

ドキュメントの開発フェーズは 2019 年 9 月 2 日から 2019 年 11 月 22 日まで実施されます。(長期にわたるプロジェクトの場合、終了日は異なります)。この期間中、メンターと緊密に連携してプロジェクトに取り組みます。

このフェーズでのテクニカル ライターとしてのタスク

メンターと協力してプロジェクトを完成させましょう。

メンターと緊密に連携してプロジェクトを完成させましょう。オープンソース コミュニティの手順に従って、作成されたドキュメントのレビューをリクエストし、更新をオープンソース リポジトリに送信します。たとえば、GitHub でホストされているオープンソース プロジェクトでは、レビューと送信のための pull リクエストを作成して、ファイルを追加または更新します。

組織管理者に懸念事項を提起する。

メンターとのコミュニケーションについて懸念がある場合や、プロジェクトの完了に影響する可能性があるその他の問題が発生した場合は、オープンソース組織管理者にお知らせください。

お客様の責任

Google プログラム管理者からのアンケートにすべて回答します。

Google プログラム管理者は、プロジェクト途中のアンケートを送信して進捗状況を評価できます。アンケートに記入し、アンケート ドキュメントの手順に沿って Google プログラム管理者に回答を送信します。

プロジェクトの確定と評価フェーズ

プロジェクトの確定フェーズは 2019 年 11 月 25 ~ 29 日に、評価フェーズは 2019 年 11 月 25 日~ 12 月 6 日に実施されます。(長期にわたるプロジェクトの場合は日付が異なります)。プロジェクトの確定期間中に、プロジェクト レポート(最終成果物とも呼ばれます)を提出します。評価フェーズでは、メンターと Google ドキュメント シーズンの参加者としての経験について、自身の評価をお送りください。

このフェーズでのテクニカル ライターとしてのタスク

プロジェクト レポートを作成する。

プロジェクト レポート(作業プロダクトとも呼ばれます)を作成します。プロジェクト レポートには、ドキュメントのシーズン中に行った作業の説明と、関連するリンクが含まれます。

プロジェクト レポートの作成

2019 シーズンの Google ドキュメント プロジェクトの最終フェーズが終了しました。

メンターにプロジェクト レポートの確認を依頼します。

メンターは、自分の功績を語るうえで貴重な洞察を与えてくれるかもしれません。また、メンターがプロジェクトを完了とマークする前の段階で、プロジェクトの状態を共有して理解しておくことも有効です。

プロジェクト レポートを完成させる

2020 年 2 月 28 日 18:00(UTC)までにプロジェクト レポートを確定してください。フォームは編集可能ですが、所定の日付までに最終版を提出する必要があります。

2019 シーズンの Google ドキュメント プロジェクトの最終フェーズが終了しました。

メンターに対する評価と、ドキュメント シーズンの体験を書き込んで提出します。

2020 年 2 月 28 日 18:00(UTC)までに評価を完了して送信してください。

テクニカル ライターによる評価

お客様の責任

2019 シーズンの Google ドキュメント プロジェクトの最終フェーズが終了しました。

長期にわたるプロジェクト

「ドキュメント シーズン」の標準長のテクニカル ライティング プロジェクトの場合、ドキュメントの作成フェーズは 2019 年 9 月 2 日から 2019 年 11 月 22 日まで実施されます。ただし、一部のテクニカル ライターは、オープンソース団体との協議のもと、長時間にわたるプロジェクトを申請する場合があります。長期にわたるプロジェクトの場合、ドキュメントの開発フェーズは 2019 年 9 月 2 日から 2020 年 2 月 21 日に行われます。

長期にわたるプロジェクトの確定と評価期間は 2020 年 2 月 24 ~ 28 日です。

タスクと責任は、このページで説明されている標準長さのテクニカル ライティング プロジェクトと同じですが、プロジェクトの確定と評価の日付は後になります。