このページは Cloud Translation API によって翻訳されました。

テクニカルライティングアプリケーションの作成

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

このページでは、テクニカルライター向けに、ドキュメントシーズンに参加するアプリの主要なパートを完了する方法のヒントを紹介します。この情報は、オープンソース組織が Google ドキュメントのシーズン中にメンタリングするテクニカルライティングプロジェクトを選択する際に考慮する要素を理解するのに役立ちます。

はじめに

以下のガイドラインは、通常、「ドキュメントのシーズン」に適用されます。個々のオープンソース組織には、特定の評価基準がある場合があります。申請書を提出する前に参加組織に連絡し、要件について話し合ったり、プロジェクト提案の計画を立てたりすることができます。テクニカルライターガイドで説明されているテクニカルライターの探索フェーズをご覧ください。

申請フォーム

申請フォームは、テクニカルライターの応募フェーズでテクニカルライターガイドから入手できます。

フォームを送信した後も、テクニカルライターの申請フェーズの終了日（2020 年 7 月 9 日）までは、フォームの情報を引き続き更新できます。

個人情報

申請フォームでは、次の個人情報が求められます。

氏名: 氏名を入力してください。Google ドキュメントシーズンでは、この名前をオープンソース団体と共有せず、ウェブサイトにも公開しません。
任意の表示名: ドキュメントのシーズンへの参加中に公開 ID として使用する名前を指定します。表示名には本当のフルネームは使用しないことを強くおすすめします。シーズンの Google ドキュメントでは、応募フォームで指定したオープンソース団体と表示名が共有されます。表示名がウェブサイトの承認済みのテクニカルライティングプロジェクトのリストに表示されます
メールアドレス: Google アカウントに関連付けられているメールアドレスを指定します。（ドキュメントシーズンに参加するには Google アカウントが必要です。Google アカウントで Gmail 以外のメールアドレスを使用できます。こちらのヘルプ記事をご覧ください）。シーズンの Google では、ユーザーと連絡を取り、ウェブサイトのリソースを利用できるようにするために、ユーザーのメールアドレスを使用します。シーズンの Google ドキュメントでは、このメールアドレスを、応募フォームに記載したオープンソース団体と共有します。このメールアドレスはウェブサイトには公開されません

「ドキュメントのシーズン」で応募フォームの内容がどのように使用されるかについては、下記をご覧ください。

テクニカルライティングの経験に関する情報

オープンソースのメンターや組織管理者は、プロジェクトの提案を検討する際に、あなたのテクニカルライティングの経験に興味を示します。フォームの詳細は、次のように指定できます。

最近のテクニカルライティング業務: 最新のテクニカルライティング関連の職種または実務経験を 3 つまで入力できます。オープンソースドキュメントの経験をお持ちの場合は、こちらにも記載してください。自分の役割、役割の責任、完了した作業をまとめます。該当する場合は日付を指定できます。
履歴書へのリンク: （省略可）一般公開されている履歴書やカリキュラム（CV）の URL。
作業サンプルへのリンク:（省略可）一般公開されている執筆例のポートフォリオの URL、または作品例への個別のリンク。
その他の追加事項: （省略可）このアプリケーションを追加する任意の情報。たとえば、技術ドキュメントへの関心、ドキュメントシーズンへの参加を希望する理由、その他の関連する経験などです。

プロジェクト提案書

プロジェクト提案は、Google ドキュメントのシーズン中に、選択したオープンソース組織と協力して行うドキュメント作業の概要です。

最大 3 つのプロジェクト提案を送信できます。プロジェクト提案はすべて、同じ申請フォームで行う必要があります。

次のガイドラインに留意して、プロジェクトの提案に時間をかけてください。

準備作業:

参加しているオープンソース組織のリストを確認し、関心のある組織を 1 つ以上選択します。選択したオープンソース組織が提案したプロジェクトのアイデアをご覧ください。

参加しているオープンソース団体
関心のある組織がアイデアを提案していない場合は、プロジェクトアイデアの一般的なリストを確認し、いずれかのアイデアに基づいてアイデアを作成できます。また、組織がアイデアを投稿しているかどうかに関係なく、自分のアイデアを考えることもできます。
1 つ以上の参加組織に連絡して、プロジェクトのアイデアについて話し合います。連絡するには、参加組織のリストに表示されている組織のメールアドレスを使用します。早期の話し合いは優れたプロジェクト提案の作成に役立ちます

申請フォーム上のプロジェクト提案:

オープンソースの組織名: ドキュメントのシーズン中に連携するオープンソース組織の名前を入力します。これは、Season of ドキュメントのウェブサイトに掲載されている参加組織のいずれかである必要があります。

参加しているオープンソース団体
オープンソースプロジェクト名: ドキュメントのシーズン中に作業するオープンソースプロジェクトの名前です。プロジェクトは、Season of Docs のウェブサイトに掲載されている参加組織のいずれかに属している必要があります。組織によっては、組織名とプロジェクト名が同じである場合があります。
提案したテクニカルライティングプロジェクトの名前。提案する作品の主な目標を要約した、簡潔でわかりやすいタイトルを付けます。
詳細な説明。提案するテクニカルライティングプロジェクトの説明を可能な限り詳しく記述してください。説明欄には複数の段落を入力しても構いません。含める内容の例を以下に示します。
- 作成または更新を提案するドキュメントの詳細を記入します。既存のドキュメントやサイトを更新する場合は、提案する更新について、リンクを含めて説明してください。新しいドキュメントやサイトを提案する場合は内容と対象読者について記載します
- 新しいドキュメントや更新を提案する理由を説明します。
- オープンソース組織の担当者とプロジェクトについて話し合ったことがある場合は、その議論の結果の概要を記載してください。
- 提案の言語とスタイルに注意を払ってください。オープンソース団体は、提案を評価する際の要素としてこれらを使用できます。
- プロジェクトの説明へのリンクを指定しないでください。説明には、プロジェクトの最終的な詳細をすべて含める必要があります。オープンソース組織は、他の場所にあるコンテンツではなく、申請フォームの内容に基づいて選択できるようにする必要があります。説明を補足する他のコンテンツにリンクする必要がある場合は問題ありませんが、プロジェクトの選択には申請フォームのコンテンツのみが使用されることに注意してください。

申請フォームのその他の重要項目

申請フォームで提供する必要があるその他の重要な情報について、ガイドラインを以下に示します。

標準の長さまたは長期間のプロジェクトを選択する: ドキュメントのシーズンのドキュメント開発フェーズの標準期間は 3 か月です。プロジェクトでそれより長い期間が必要な場合は、任意のオープンソース団体との協議後に、申請フォームでその旨を明記する必要があります。長時間実行プロジェクトの説明をご覧ください。
このシーズンの Google ドキュメントの給付金の受給: シーズンの Google ドキュメントでは、プロジェクトを無事に完了したテクニカルライターに賞金が支払われます（ただし、そのテクニカルライターが奨励金の受け取りを希望している場合）。テクニカルライターの給付金に関する情報をご覧ください。給与の付与は任意です。給付金の受け取りを希望されない場合は、申請フォームに希望をお知らせください。

Google スプレッドシートで応募フォームからの情報を活用する仕組み

このセクションでは、ドキュメントシーズンで申請フォームからの情報がどのように使用されるかについて概説します。このページの前のセクションでは、主なフィールドについて詳しく説明します。

表に主なフィールドを示します。各フィールドには、ドキュメントのシーズンが次のどれに該当するかが表で示されます。

応募フォームで指定したオープンソース団体に情報を渡します。
Season of Docs のウェブサイトで承認済みのテクニカルライティングプロジェクトのリストに情報を公開する。

フォームの情報	オープンソース組織と共有しますか？	「ドキュメントシーズン」のウェブサイトでの表示
フルネーム
表示名
メールアドレス
最近のテクニカルライティングの経験
履歴書または CV へのリンク
仕事用のサンプルへのリンク
その他のご意見やご要望
オープンソースの組織/プロジェクト名
テクニカルライティング用プロジェクトの名前と説明
長期にわたるプロジェクトまたは標準の長さのプロジェクト
給付金の受領

上の表で使用されている記号の要点:

記号	記号の意味
	○
	×

メモ

次の点にもご注意ください。

複数のプロジェクト提案を送信する: 複数のプロジェクト提案を送信できますが、当シーズンではテクニカルライター 1 人につき 1 つのプロジェクト提案しか受け付けられません。送信できる申請フォームは 1 つのみです。このフォームでは、最大 3 つのプロジェクト提案を作成できます。
プログラムのテクニカルライティングプロジェクトの合計数: シーズンの Google ドキュメントでは、テクニカルライティングプロジェクトの合計数に上限があります。スロット割り当ての仕組みを確認する。