テクニカル ライターの選定

現在のフェーズ:
ドキュメントの作成。タイムラインをご覧ください。

このページには、オープンソース団体向けに、Google シーズン ドキュメント プロジェクト提案書に適切なテクニカル ライターを評価して選択するためのヒントが記載されています。

はじめに

オープンソース組織は、提案されたプロジェクトに取り組むためにテクニカル ライターを雇う必要があります。組織は、独自のテクニカル ライターを調達する必要があります。Google シーズン ドキュメントの Google シーズンに参加する組織との連携に関心があるテクニカル ライターは、Google シーズン ドキュメントの GitHub リポジトリと、Write the Docs Slack の #season-of-docs チャンネルをご覧ください。

プロセスの開始

Google シーズンの Google ドキュメントへの参加が必要になりそうな場合は、できるだけ早くテクニカル ライターを見つけるプロセスを開始することをおすすめします。

テクニカル ライターの評価

検討しているテクニカル ライターに、以前に開発したドキュメントのサンプルをリクエストして、テクニカル ライティングのスキルと経験を評価できるようにすることをおすすめします。

テクニカル ライティングのスキルと経験

  • テクニカル ライターのこれまでの経験を確認します。テクニカル ライターには、ソフトウェア業界向けの技術ドキュメントの作成経験があることが理想的です。Google シーズン Google ドキュメントの目標の 1 つは、テクニカル ライターにデベロッパー向けのプロダクトに関わる機会を提供することです。そのため、プロジェクトの対象がデベロッパーの対象であっても、ライターが API、SDK、またはその他のデベロッパー プラットフォームの経験を持っていることは重要ではありません。

  • 言語スキルとコミュニケーション スキルを重視。 この視点から、テクニカル ライターの以前の作業を評価します。最も重要なことは、その人物が何を書いたかを理解できることです。テクニカル ライターの作業言語を詳細にレビューする場合は、句読点とフレーズの一貫性、正しいスペル、明確な表現を確認してください。フレーズはシンプルですか、それとも複雑ですか?文章は短いか 理解しづらくなるまで 長文にするか

  • ドキュメントの設計とレイアウトに注意してください。ドキュメント サンプルの全体的なレイアウトを確認する。設計は論理的か?ドキュメントやドキュメント セットの操作方法がすぐにわかりますか?コンテンツの重複や明らかなギャップの有無。

テクニカル ライターの採用

組織は、2024 年 5 月 22 日 18:00 UTC までにテクニカル ライターを雇用し、以下のリンク先の「テクニカル ライター採用証明書」のフォームに記入する必要があります。

テクニカル ライターの採用フェーズが完了しています。

採用する前に、必ず報酬支払いスケジュールについてテクニカル ライターと話し合ってください。プロジェクトのキックオフ時の支払いなど、プロジェクトのマイルストーンに基づいて、テクニカル ライターとの支払いスケジュールを作成することをおすすめします。お支払い日はプログラム全体で 2 回しか行われず、お支払いスケジュールを作成する際には金額に注意してください。

注: テクニカル ライターを雇用しておらず、2024 年 5 月 22 日 18:00(UTC)までにテクニカル ライター採用フォームを提出していない組織は、最初の支払い日に資金を受け取ることはできません。