與技術文件作者合作

目前階段：
結果公布時程。

以下是一些可以協助開放原始碼機構與技術文件撰寫專員有效合作的原則。

將技術文件撰寫者介紹開放原始碼的世界，與您的社群分享

  • 讓技術文件撰寫專員為您的社群提供「導覽」。哪裡可以提問？他們應該參加哪些定期會議，或者他們應該加入哪些郵寄清單？客戶需要哪些帳戶 (GitHub、Discord、Slack)務必瞭解專案的行為準則，並瞭解如何回報問題。請確認您的技術文件編寫者瞭解您的專案授權，並遵守其他雇主簽署《客戶責任法案》、《DCO》或其他協議的相關要求。
  • 請盡可能將他們介紹給位於相同時區的少數人員，方便他們快速回覆社群或專案相關問題。
  • 如果可以，請傳送一些專案贈品給他們！

協助技術文件撰寫專員使用參與專案的工具和程序

  • 如果流程不夠詳盡，請安排時間引導技術文件撰寫者處理其首次貢獻、問題或提取要求。他們應該使用哪些範本或標記？誰需要審查自己的貢獻？他們應該在何時以何種方式追蹤評論？如果工作內容包含程式碼範例，要如何測試？他們需要知道您的 CI/CD 程序或版本有哪些？

協助技術文件撰寫專員瞭解您的專案及其使用者

  • 請詳細說明您的專案，讓技術文件撰寫者對您產品的概念有一定的理解。這有助於技術撰寫者在撰寫專案內容時更有信心，也更具權威性。
  • 說明專案使用者的需求。請盡可能具體說明，不只是「開發人員」，而是「建立網站的開發人員」和「採用工業機器人程式的開發人員」。
  • 引導技術文件撰寫專員聯絡必要的領域專家。也就是說，負責專案內容的開發人員或其他專案協作者。
  • 確保技術文件撰寫專員能向主題專家和其他社群成員提供所需的時間和資源。

提出問題！

  • 你的社群或專案可能未曾與技術撰寫者或說明文件貢獻者合作。利用機會學習並分享知識！詢問對方對於工作流程和工具的意見，您的技術內容撰寫專員可能會提供一些改善建議。