建立技術撰寫者協議

當前階段:
說明文件開發。請參閱時間表

本頁內容與技術撰稿人簽訂 Google 文件季別協議時,需要考量幾個問題。這並不是法律建議,也不是針對開放原始碼專案製定技術撰寫協議時,需要考量的所有可能要點。視貴機構或專案的需求而定,在培訓技術撰寫專員之前,建議您先諮詢自己的法律顧問。

工作範疇

  • 建立協議所涵蓋作品的清單。越具體越好。舉例來說,與其提供「API 說明文件」,列出需要記錄的端點以及必須納入的資訊,例如 curl 指令範例或參數清單。
  • 如何得知某項內容是否「完成」?
  • 其他注意事項:
    • 作品版權的擁有者是誰?它將根據何種授權釋出 (這些授權不同!)?技術撰稿人可獲得什麼抵免額 (在網站上提及、列為貢獻者等)?如果內容日後需要重新授權呢?舉例來說,如果您預期技術寫入者簽署開放原始碼專案的《Contributor License Agreement》,請告知對方。
    • 若您預期技術寫入者參與多個修訂版本通過,請寫下來。例如,您可以指出預期第一次草稿,其次是解決技術問題,然後通過校對最終通過。
    • 如果預期技術寫入人員會以 Markdown 等特定格式提交內容,請在協議中加入。
    • 您的專案是否有使用生成式 AI 建立說明文件或程式碼的相關規範?請務必將這些規範分享給技術撰稿人。

薪酬

  • 根據公司與可交付項目訂定的付款時間表,與技術撰稿人達成共識。
  • 工作開始時,您是否會預付費用?
  • 如果無法使用或接受作品 (因為專案優先順序已變更或審查人員退出等),會發生什麼情況?你能支付「技能費」,協助補償技術撰寫人員所花的時間嗎?
  • 誰負責支付與所選付款方式相關的任何貨幣換算費用?

通訊

  • 是否預期技術撰寫人員能進行視訊通話或會議?
  • 您會使用哪些通訊管道?預計回應時間為何?舉例來說,如果您預期技術寫入者在一天內回覆電子郵件 (或 Slack 中的訊息),請明確告知這個設定。
  • 該專案中的誰都可以聯絡技術撰寫人員,詢問不同問題,如付款問題、需要審查、解決工具或管道問題,或是其他攔截器?
  • 作家是否應使用特定程序來提交作品,或取得意見回饋或評論?

工具

  • 技術撰寫人員需要使用哪些工具 (或工具版本) 製作他們的工作?
  • 誰負責協助技術撰寫人員設定、取得存取權或取得權限?

解決爭議

  • 您要如何解決與技術撰寫人員工作品質方面的異議?誰得到最終答案?
  • 要從專案中釋出技術撰寫人員的流程為何?例如,連續缺少三個期限,或是繳交違反品質規定的工作。執行該程序時,請考慮提供明確的後續步驟 (「我們預期在下週五前提交第一個草稿的提取要求」,而不是「請盡快提交工作」)。
  • 如果技術文件寫作者需要退出,他們應該如何向對方傳達這件事?如果可以,他們是否應該發出通知、建立交接文件或聯繫交接文件?
  • 別忘了將專案義務考慮給技術寫入者。舉例來說,如果您的專案導師中斷且無法更換,或是無法完成承諾的審查,請考慮將剩餘部分資金支付給技術撰寫人員,即使專案無法完成,也要考慮將部分剩餘款項補償給撰寫者。
  • 明確指出技術寫入者受專案的行為準則,並連結至您的行為準則強制執行程序。建議您明確指出違反 CoC 政策將導致專案終止,並導致任何未完成的工作支付款項。