當前階段:
說明文件開發。請參閱時間表。
以下提供一些準則,協助開放原始碼機構有效發揮技術撰稿人的能力。
向社群介紹開放原始碼技術撰寫人員
- 邀請技術作家擔任社群「導覽」。他們在哪裡提問?他們應該參加哪些定期會議?他們應該加入哪些郵寄清單?客戶需要哪些帳戶 (GitHub、Discord、Slack)?確保他們瞭解您的專案的行為準則,並知道如何回報問題。請確認您的技術撰寫人員瞭解專案的授權,且遵守其他雇主在簽署 CLA、DCO 或其他協議方面的要求。
- 如果可以,請將他們介紹給不同時區的幾個人,讓他們能快速回應社群或專案相關問題。
- 可以的話,你可以將專案小禮物寄給他們!
協助技術撰稿人使用參與專案所參與的工具和程序
- 如果程序未能妥善記錄,請設定時間來安排技術撰稿人瞭解其首次貢獻、問題或提取要求。他們該使用哪些範本或標記?誰需要審查他們提供的內容?追蹤評論的方式和時機為何?如果工作內容包含程式碼範例,要如何測試?他們需要知道哪些 CI/CD 程序或版本?
協助技術撰寫人員瞭解您的專案和使用者
- 請詳細說明您的專案,讓技術撰寫人員充分瞭解產品的概念。這有助於技術撰寫人員更加自信,在撰寫專案時也更具權威性。
- 說明專案使用者的需求。請盡可能具體細節,不只是「開發人員」、「建立網站的開發人員」和「開發人員設計工業機器人」。
- 讓技術文件撰寫專員與必要的主題專家聯絡。也就是說,負責該說明文件涵蓋的專案方面,負責專案領域的開發人員或其他專案貢獻者。
- 確保技術撰寫人員能向主題專家和其他社群成員取得所需時間和資源。
提出問題!
- 您的社群或專案可能之前沒有與技術撰寫人員或說明文件貢獻者合作。您可以把握這個機會學習新知 同時分享所學知識詢問您對流程和工具的意見;技術撰寫人員可能會提出一些改善建議。