签订技术文档协议

当前阶段：
案例研究已发布。请参阅时间轴。

本页面列出了在与技术文档撰写者就 Google 文档季节项目签订协议时需要考虑的一些问题。本文并非法律建议，也未详尽列出为开源项目创建技术文档协议时应考虑的所有可能事项。根据贵组织或项目的需求，您可能需要在招聘技术文档撰写者之前咨询自己的法律顾问。

工作范围

• 列出协议涵盖的工作。请尽可能具体说明。例如，请列出需要记录哪些端点以及必须包含哪些信息（例如 curl 命令示例或参数列表），而不是列出“API 文档”。
• 如何知道某项内容是否已“完成”？
• 其他注意事项：
  • 谁将拥有该作品的版权？该应用将采用哪种许可（这些许可不同！）？技术文档工程师将获得哪些署名（在网站上提及、列为贡献者等）？如果内容日后需要重新获得许可，该怎么办？例如，如果您希望技术文档撰写者签署开源项目的贡献者许可协议，则应告知对方。
  • 如果您希望技术文档撰写者参与多次修订流程，请明确说明。例如，您可以说明您希望先完成第一稿，然后进行第二次修改以解决技术问题，最后进行最终修改以进行校对。
  • 如果您希望技术文档撰写者以特定格式（例如 Markdown）提交内容，请在协议中注明这一点。
  • 您的项目是否有关于使用生成式 AI 创建文档或代码的指南？请务必与您的技术文档撰写者分享这些准则。

薪酬

• 与技术文档工程师就与确切日期和交付成果相关联的付款时间表达成一致。
• 您是否会在工作开始时支付预付款？
• 如果工作无法使用或被接受（因为项目的优先级发生了变化，或者审核员退出了等），会怎么样？您能否支付“终止费用”，以补偿技术编写人员所花费的时间？
• 与所选付款方式相关的所有货币换算费用由谁承担？

通信

• 您希望技术文档工程师是否可以参加视频通话或会议？
• 您将使用哪些沟通渠道，预计回复时间是多长？例如，如果您希望技术文档撰写者在一天内回复电子邮件（或 Slack 消息），请明确说明这一点。
• 技术编写人员如需咨询各种问题（例如付款问题、需要审核、解除工具或渠道屏蔽问题或其他屏蔽问题），可以联系项目中的哪些人？
• 作者提交作品或获取反馈或评价时，是否应遵循特定流程？

工具

• 技术文档撰写者需要使用哪些工具（或工具版本）来创作作品？
• 谁负责帮助技术文档撰写者进行设置、获取访问权限或权限？

解决分歧

• 您如何解决关于技术文档撰写者工作质量的分歧？谁拥有最终决定权？
• 从项目中移除技术文档工程师的流程是什么？ 例如，连续三次错过截止日期，或者提交的作业质量不符合要求。在强制执行流程时，不妨明确说明后续步骤（例如“我们希望您在下周五之前提交第一稿的拉取请求”，而不是“请尽快提交您的工作”）。
• 如果技术文档工程师需要退出项目，该如何告知？如果可能，他们是否应发出通知、创建交接文档或进行交接通话？
• 别忘了考虑项目对技术编写者的义务。例如，如果您的项目导师退出项目且无法替换，或者无法完成承诺的审核，不妨考虑将剩余资金的一部分支付给技术文档撰写者，即使项目无法完成，也要补偿文档撰写者所花费的时间。
• 明确说明技术文档工程师必须遵守项目的行为准则，并提供指向行为准则违规处置流程的链接。您可能需要明确说明违反《合作规范》将导致项目终止，并没收所有未完成工作的付款。