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

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

このガイドは、2021 年シーズン ドキュメント プログラムで承認された組織との連携に関心のあるテクニカル ライターを対象としています。

2021 シーズンの Google ドキュメント プログラムに参加する必要はありますか?

以下の質問は、2021 シーズン Google ドキュメント プログラムで承認された組織との連携に興味があるかどうかを把握するのに役立ちます。

  • テクニカル ライティングのスキルと経験はありますか。「ドキュメントのシーズン」は、基本的なテクニカル ライティングのスキルを教えることを意図したものではありません。自発性と計画性に優れていますか?
  • プログラムの半年(2021 年 4 月~ 11 月)にご参加いただく時間はありますか?プロジェクトの規模はさまざまだが、プログラムの期間中、週 5 ~ 30 時間の業務を予定している。
  • オープンソースに関する経験を積みたいとお考えですか?プロジェクトのプロセスやコミュニティ規範の習得に時間を費やしたいとお考えですか?
  • 組織管理者と協力して、プロジェクト提案の改善、タイムラインの策定、指標の評価と集計を行い、組織全体がテクニカル ライティングの価値を理解できるよう支援する意欲はありますか?

また、Open Collective アカウントの作成など、プログラムの参加要件も満たしている必要があります。居住地で行った作業に対する資金を、法的に受け取ることができる必要があります。「ドキュメントのシーズン」プログラムの管理者は、税務に関するアドバイスを提供したり、勤務条件に関する質問に回答したりすることはできません。

シーズン オブ ドキュメントに参加する熟練したテクニカル ライターは、オープンソースでの経験を積んで、優れたドキュメントを通じて重要なニーズの解決を支援できます。

テクニカル ライターとして 2021 シーズンの Google ドキュメント プログラムに参加

調査フェーズ

組織への応募の締め切りは 2021 年 3 月 26 日 18 時(UTC)です。テクニカル ライターの方には、考えられるプロジェクトについて、できるだけ早く検討を開始することをおすすめします。ただし、2021 年 5 月 17 日 18:00(UTC)より前であれば、組織は作業するテクニカル ライターをいつでも選択できます。

  • 興味のあるプロジェクトを見つける
    • 「シーズン オブ ドキュメント」プログラム ページの手順に沿ってオープンソース団体に直接お問い合わせください。または、シーズン オブ ドキュメントの GitHub リポジトリを参照して、シーズン オブ ドキュメントの参加に関心を示した組織を見つけてください。関心のある組織については、Write the Docs Slack の #season-of-docs チャンネルもご覧ください。
    • プロジェクトを選択するには、次のような方法があります。
      • JavaScript や C など、自分が使い慣れている、または興味のある言語でプロジェクトを選択します。
      • ML、オープン サイエンス、ロボット工学など、興味のあるテクノロジーや分野のプロジェクトを選択します。
      • コミュニティの親しみやすさに基づいてプロジェクトを選ぶ。ディスカッション フォーラムに参加したり、コントリビューターのソーシャル メディア アカウントをチェックしたり(そこでプロジェクトについて話している場合)、オンボーディング ドキュメントを確認します。
      • 取り組みたいプロジェクトがプロジェクト リストにない場合は、そのプロジェクトに連絡し、申請を検討するよう依頼してください。
  • プロジェクトのプロポーザル ページを確認します。
    • 考えられるプロジェクトが 3 ~ 5 件決まったら、各プロジェクトの提案ページを確認します。
    • プロジェクトがフィードバックとディスカッションのためにリストアップしたチャネルを使用して、質問、フィードバックの提供、提案を行う必要があります。
  • ご興味をお持ちの旨を団体に直接提出してください。申込書には、組織のプロジェクト提案で定められた目標を達成する方法を記載します。
    • シーズンのドキュメントの申込書テンプレートをご利用ください。できるだけ短くする
    • 組織のアイデアのページに記載されている手順に沿って、参加申請書を提出します。組織が特別な要件を記載している場合は、その要件を満たしていることを明細書で示す必要があります。
    • 利害関係表明書を提出すると、組織の行動規範と「ドキュメント シーズンの行動規範」の遵守に同意することになります。

申請フェーズ

  • ドキュメントのシーズンごとに参加団体の発表があるまでお待ちください。
    • 参加をご希望の参加団体が貴社との提携を希望する場合は、参加団体からご連絡します。
    • 組織の申請期限までに、関心表明を提出したテクニカル ライターのみと連携することに制限されません。承認後、さらに興味 / 関心の表明を求める場合があります。組織は、2021 年 5 月 17 日 18:00 UTC までにテクニカル ライターを選定する必要があります。
    • 組織は、興味 / 関心の表明がうまくいかなかった場合にフィードバックを提供する義務はありません。

プロジェクト開発フェーズ

  • 組織と協力してスケジュール(成果物や期限など)を作成します。

最終評価とケーススタディのフェーズ

  • 組織と協力して、最終的な評価とケーススタディに必要な情報を提供する。