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