現在のフェーズ:
2021 年シーズン オブ ドキュメント プログラムは 2021 年 12 月 14 日に終了しました。タイムラインをご覧ください。
このページでは、オープンソース組織を対象とした、当シーズンの Google ドキュメント プロジェクト提案に適したテクニカル ライターを評価して選択する際のヒントを紹介します。
はじめに
オープンソース組織は、提案されたプロジェクトに取り組むためにテクニカル ライターを雇う必要があります。組織は独自のテクニカル ライターを調達する必要があります。「ドキュメント シーズン」に参加している組織との連携に関心をお持ちのテクニカル ライターの方は、Season of Docs GitHub リポジトリと、Write the Docs Slack の #season-of-docs チャンネルをご覧ください。
テクニカル ライターの評価
検討しているテクニカル ライターに、以前に開発したドキュメントのサンプルをリクエストすることをおすすめします。そうすれば、ライターのテクニカル ライティング スキルや経験の評価に集中できます。
テクニカル ライティングのスキルと経験
テクニカル ライターのこれまでの経験を確認する。テクニカル ライターには、ソフトウェア業界の技術ドキュメントの作成経験がある程度あることが理想的です。「ドキュメント シーズン」の目標のひとつは、テクニカル ライターがデベロッパー向けのプロダクトに関わる機会を提供することです。そのため、作成するプロジェクトがデベロッパー向けであっても、ライターに API、SDK、その他のデベロッパー プラットフォームの経験は必要ありません。
言語スキルとコミュニケーション スキルに注力します。 この視点からテクニカル ライターの過去の作業を評価します。最も重要なのは、相手が何を書いたか理解できているかということです。テクニカル ライターの著作物の言語を詳細にレビューする場合は、句読点とフレーズの一貫性、正しいスペル、明確な表現に注意してください。フレーズはシンプルですか、それとも複雑ですか？センテンスは短いか 理解しづらくなるまで継続しているか
ドキュメントの設計とレイアウトに注意を払う。ドキュメント サンプルの全体的なレイアウトを確認します。デザインは論理的ですか？ドキュメントやドキュメント セットの使い方が簡単に見つかるでしょうか。コンテンツの重複や明らかなギャップの有無。