当前阶段:
文档制作。请参阅时间表。
本页面包含针对 Google 文档季与技术文档撰写人达成协议时需要考虑的一些问题。这并非法律建议,也不是为开源项目创建技术编写协议时需要考虑的所有可能要点的详尽列表。根据您的组织或项目的需求,在入职技术文档工程师之前,您可能需要咨询自己的法律顾问。
工作范围
- 列出您的协议所涵盖的作品。请尽可能具体。例如,创建需要记录的端点以及必须包含哪些信息(例如示例 curl 命令或参数列表)的列表,而不是“API 文档”。
- 如何判断一段内容是否“已完成”?
- 其他需要考虑的事项:
- 作品的版权归谁所有?它将在什么许可下发布(这是不同的!)?技术文档工程师将获得什么荣誉(在网站上被提及、列为贡献者等)?如果内容将来需要重新获得许可,该怎么办?例如,如果您希望技术文档工程师签署您的开源项目的贡献者许可协议,则应传达这一点。
- 如果您希望技术文档工程师参与多个修订流程,请详细列出。例如,您可以声明您期望生成第一个草稿,然后需要第二次传递以解决技术问题,然后是最终遍历以进行校对。
- 如果您希望技术文档工程师以特定格式(例如 Markdown)提交内容,请在您的协议中包含此信息。
- 您的项目是否有使用生成式 AI 创建文档或代码的准则?请务必与您的技术文档工程师分享这些准则。
薪酬
- 就与确定日期和交付成果绑定的付款时间安排与技术文档工程师达成一致。
- 您是否会在工作开始时预先支付费用?
- 如果工作因以下原因而无法使用或被接受(因为项目的优先级已更改或者审核人员退出等),会发生什么情况?您能否支付“终止费”来补偿技术文档工程师所花费的时间?
- 与所选付款方式相关的任何货币换算费用由谁负责?
沟通
- 您是否希望技术文档工程师有空进行视频通话或会议?
- 您将使用哪些沟通渠道?预计响应时间是多长?例如,如果您希望技术文档工程师在一天内回复电子邮件(或 Slack 中的消息),请明确指出这一点。
- 对于不同的问题(例如付款问题、需要审核、解除工具或渠道问题或其他障碍),技术文档工程师应该与谁联系?
- 撰写者在提交作品或获取反馈或评价时,应遵循特定的流程吗?
工具
- 技术文案需要使用哪些工具(或工具版本)来创作成果?
- 谁负责帮助技术文档工程师进行设置、获取访问权限或获取权限?
消除分歧
- 你们如何解决在技术文档撰写人工作质量方面存在的分歧?谁有最终决定权?
- 从项目中移除技术文档工程师的流程是怎样的?例如,连续缺少三个截止日期,或上交质量令人无法接受的作业。在强制执行该流程时,请考虑提供明确的后续步骤(“我们预计会在下周五之前提交一份针对初稿的拉取请求”,而不是“请尽快提交您的工作”)。
- 如果技术文档工程师需要退出,他们应该如何沟通?如果可能,他们是否应该给予通知、创建移交文档或进行移交通话?
- 别忘了考虑项目对技术文档工程师的义务。例如,如果您的项目导师中途离开且无法被替换,或者如果承诺的审核无法完成,那么即使项目无法完成,也可以考虑向技术撰写者支付一部分剩余资金,以补偿撰写者的时间。
- 明确声明技术文档工程师受项目行为准则约束,并链接到行为准则违规处置流程。您可能需要明确指出,违反 CoC 规定将导致项目终止,并且放弃所有未结工作的付款。