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