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

現在のフェーズ:
結果が発表されましたタイムライン

このページでは、オープンソース組織を対象とした、当シーズンの Google ドキュメント プロジェクト提案に適したテクニカル ライターを評価して選択する際のヒントを紹介します。

はじめに

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

プロセスの開始

「ドキュメントのシーズン」への参加が必要と思われるときは、できるだけ早くテクニカル ライターを見つけるプロセスを開始することをおすすめします。

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

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

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

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

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

  • ドキュメントの設計とレイアウトに注意を払う。ドキュメント サンプルの全体的なレイアウトを確認します。デザインは論理的ですか?ドキュメントやドキュメント セットの使い方が簡単に見つかるでしょうか。コンテンツの重複や明らかなギャップの有無。

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

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

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

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

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