現在のフェーズ:
ケーススタディが公開されています。タイムラインをご覧ください。
オープンソース組織が技術ライターと効果的に連携するためのガイドラインをいくつかご紹介します。
技術ライターにオープンソースの世界とコミュニティを紹介する
- テクニカル ライターにコミュニティの「ガイド付きツアー」を提供します。質問できる窓口はどこですか？どのような定期的なミーティングに参加すべきか、どのようなメーリング リストに参加すべきか。どのようなアカウントが必要か（GitHub、Discord、Slack）プロジェクトの行動規範を理解し、問題を報告する方法を理解していることを確認します。技術ライターがプロジェクトのライセンスを理解し、CLA、DCO、その他の契約の署名に関する他の雇用主の要件を遵守していることを確認します。
- 可能であれば、コミュニティやプロジェクトに関する質問に迅速に対応できる、同じタイムゾーンにいる数名の社員を紹介してください。
- 可能であれば、プロジェクトのグッズを送ってください。
テクニカル ライターがプロジェクトへの貢献に関連するツールとプロセスを使用できるようにサポートする
- プロセスが十分に文書化されていない場合は、技術ライターが初めての貢献、問題、プルリクエストを行う際に、その手順を説明する時間を設定します。どのテンプレートまたはタグを使用すればよいですか。誰が貢献をレビューする必要があるか、レビューのフォローアップをどのように、いつ行うべきか。作業にコードサンプルが含まれている場合、どのようにテストできますか？CI/CD プロセスまたはリリースについて、チームが知っておくべきことは何ですか？
技術ライターがプロジェクトとそのユーザーを理解できるようにする
- 技術ライターがプロダクトの概念をしっかりと理解できるように、プロジェクトを詳しく説明します。これにより、技術ライターはプロジェクトの執筆において自信を持ち、信頼性を高めることができます。
- プロジェクトを使用するユーザーのニーズを説明します。できるだけ具体的にします。「デベロッパー」だけでなく、「ウェブサイトを作成するデベロッパー」や「産業用ロボットをプログラムするデベロッパー」などです。
- 技術ライターと必要な分野の専門家をつなぎます。つまり、ドキュメントで取り上げるプロジェクトの側面を担当するデベロッパーやその他のプロジェクト コントリビューターです。
- 技術ライターが、対象分野のエキスパートやその他のコミュニティ メンバーから必要な時間とリソースを確保できるようにします。
質問
- コミュニティやプロジェクトで、テクニカル ライターやドキュメント作成者と一緒に作業したことがない場合があります。自分の知識を共有しながら、学ぶ機会を活用しましょう。プロセスとツールに関するフィードバックを依頼します。技術ライターは改善案を提案してくれる可能性があります。