テクニカル ライターとの連携

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

ここでは、ドキュメント シーズンでメンタリングしているテクニカル ライターとの連携方法に関する、オープンソース組織向けのガイドラインをいくつか示します。

  • テクニカル ライターをオープンソースの世界とコミュニティに紹介します。
  • テクニカル ライターがプロジェクトへの貢献に関連するツールとプロセスを使用できるようにサポートします。
  • テクニカル ライターがプロダクトについてしっかりと理解できるように、プロダクトを詳細に説明します。これにより、テクニカル ライターはプロジェクトについて確信を持て、自分の書面での信頼性を高めることができます。
  • 対象ユーザーのニーズ（つまり、プロダクトを使用するデベロッパーや、プロダクトを使用する他のグループのニーズ）を記述します。
  • テクニカル ライターとともに重要なユースケースに関するワークショップを実施し、必要なドキュメントの設計を支援します。
  • テクニカル ライターがドキュメントを作成する前にコードを理解する必要がある場合は、コードを確認してください。
  • テクニカル ライターから必要な対象分野のエキスパートに連絡します。つまり、ドキュメントで扱うプロダクトのさまざまな側面について責任を負うデベロッパーやその他のプロジェクト コントリビューターです。
  • テクニカル ライターが、対象分野のエキスパートやその他のコミュニティ メンバーから必要な時間とリソースを確実に得られるようにします。
  • テクニカル ライターと協力して、適切なコードサンプルをドキュメントに追加します。

注意点

「ドキュメント シーズン」のオープンソース メンターは、必ずしもテクニカル ライターであるとは限りません。メンターにドキュメント スキルは必要ありません。 テクニカル ライターはこれらのスキルをプロジェクトやメンタリング関係に活かします。

代わりに、メンターは、オープンソース コミュニティ、プロダクト、オープンソース プロジェクトで使用するプロセスとツールに関する知識を活かすことができます。

メンタリング関係の重要な成果は、テクニカル ライターが今年の Google ドキュメント シーズンで実りある成功を体験できたことです。幸せな体験ができれば、今年の Google ドキュメント シーズンが終わった後も、テクニカル ライターがオープンソース プロジェクトに貢献し続ける可能性が高まり、他のテクニカル ライターがオープンソースでの仕事に意欲的に取り組めるようになります。