現在のフェーズ:
2021 年シーズン オブ ドキュメント プログラムは 2021 年 12 月 14 日に終了しました。タイムラインをご覧ください。
ここでは、オープンソース組織がテクニカル ライターと効果的に連携するためのガイドラインをいくつか紹介します。
テクニカル ライターをオープンソースの世界とコミュニティに紹介する
- テクニカル ライターにコミュニティの「ガイドツアー」を提供する。どこで質問できますか？どのような定期会議に参加すべきか、どのようなメーリング リストに参加すべきか。どのようなアカウントが必要か（GitHub、Discord、Slack）？彼らがプロジェクトの行動規範を理解し、問題を報告する方法を把握していることを確認します。テクニカル ライターがプロジェクトのライセンスを理解し、CLA、DCO、その他の契約の締結に関する他の雇用主の要件を遵守していることを確認してください。
- 可能であれば、コミュニティやプロジェクトに関する質問に迅速に回答できる、タイムゾーンが重複する数名のスタッフを紹介します。
- 可能であれば、プロジェクトのグッズを送ってください。
テクニカル ライターがプロジェクトへの貢献に関連するツールとプロセスを使用できるようにする
- プロセスの説明が十分にない場合は、テクニカル ライターが最初のコントリビューション、Issue、pull リクエストを行うプロセスを説明する時間を設けます。どのテンプレートまたはタグを使用すればよいですか。自分の投稿を確認する必要があるのは誰ですか？また、レビューのフォローアップはいつ、どのように行うべきですか？作業内容にコードサンプルが含まれている場合、それらをどのようにテストできますか。CI/CD プロセスまたはリリースについて何を知っておく必要があるか。
テクニカル ライターがプロジェクトとそのユーザーを理解できるようにする
- テクニカル ライターがプロダクトについてしっかりと理解できるように、プロジェクトを詳細に説明します。これにより、テクニカル ライターはプロジェクトについて確信を持て、自分の書面での権威を振る舞うことができます。
- プロジェクトの利用者のニーズを記述します。「開発者」だけでなく、「ウェブサイトを作成する開発者」、「産業用ロボットをプログラミングする開発者」のように、できるだけ具体的に記述してください。
- テクニカル ライターから必要な対象分野のエキスパートに連絡します。つまり、ドキュメントで扱うプロジェクトのさまざまな側面を担当する開発者やその他のプロジェクト コントリビューターです。
- テクニカル ライターが、必要な時間とリソースを対象分野のエキスパートやその他のコミュニティ メンバーから得られるようにします。
何でも質問してください。
- コミュニティやプロジェクトは、これまでにテクニカル ライターやドキュメントの協力者と連携したことがない可能性があります。この機会を活用して、自分が知っていることを共有しながら学びましょう。プロセスとツールに関するフィードバックを求めます。テクニカル ライターから改善のための提案があるでしょう。