與技術文件作者合作

目前階段：
2021 年「Docs 季」計畫已於 2021 年 12 月 14 日結束。請參閱時間表。

以下提供一些指南，協助開源組織與技術作家有效合作。

向技術作家介紹開放原始碼世界和您的社群

  • 請技術作家「導覽」您的社群。他們可以在哪裡提問？他們應該參加哪些定期會議，或加入哪些電子報名單？他們需要哪些帳戶 (GitHub、Discord、Slack)？請務必確保他們瞭解專案的行為準則，並知道如何回報任何問題。請確保技術作家瞭解專案的授權，並遵守其他雇主在簽署 CLA、DCO 或其他協議方面的任何規定。
  • 盡可能向他們介紹幾位時區重疊的人員，這些人可以快速回覆社群或專案相關問題。
  • 如果你願意，不妨寄送一些專案贈品給他們！

協助技術作家使用工具和程序，為專案做出貢獻

  • 如果您的程序未妥善記錄，請安排時間，向技術撰稿人介紹他們的首次貢獻、問題或提取要求。他們應該使用哪些範本或代碼？誰需要審查自己的貢獻內容，以及他們應該如何及何時進行審查？如果他們的作品包含程式碼範例，該如何進行測試？他們需要瞭解哪些 CI/CD 程序或版本？

協助技術作家瞭解您的專案和使用者

  • 請詳細說明您的專案，讓技術作家能充分瞭解產品的概念。這有助於技術作家在撰寫專案內容時，更有自信和權威。
  • 說明使用專案的使用者需求。請盡可能具體化，不要只寫「開發人員」，而是「開發人員 (建立網站)」和「開發人員 (編寫工業機器人程式)」。
  • 讓技術作家與必要的專家聯絡。也就是說，開發人員或其他專案貢獻者負責說明文件涵蓋的專案層面。
  • 請確保技術作家能從專家和其他社群成員取得所需的時間和資源。

歡迎提問！

  • 您的社群或專案可能先前未與技術寫手或文件貢獻者合作過。把握機會，在分享所知的同時學習新知！請技術作家針對流程和工具提供意見回饋，他們可能會提出一些改善建議。