当前阶段:
2019 年 Google 文档季计划已于 2020 年 3 月 6 日结束。请参阅时间轴。
参与文档季的组织管理员对开源组织中的导师、技术文档撰写者和 Google 负有一定责任。
参与 Google 文档季的开源导师还对其开源组织、技术文档编写者参与者和 Google 计划管理员有责任。
本文档介绍了所有参与计划的开源组织适用的责任。各个组织可能还有其他角色和责任。如需了解详情,请与贵组织的管理团队联系。
组织管理员的责任
这些是开源组织中管理员的责任。
您对 Google 的责任
- 定义组织参与、组织选择标准和特定于组织的操作流程
- 提交组织申请并成为组织代表
- 充当 Google 的沟通联络人
- 在 36 小时内回复 Google 提出的任何问题
- 举报违反参与者协议的行为(例如骚扰、抄袭、欺诈)
- 报告技术文档工程师已退休
- 确保按时完成所有截止日期(例如,导师评估、组织账单)
- 挑选并邀请值得信赖、能力出众且合格的导师
- 提供并维护一个详尽的项目和任务建议清单
- 监督所有导师和技术文档工程师的活动,确保履行职责
您对导师的责任
- 定义组织参与、导师要求、失败流程和流程
- 在计划开始之前告知导师的预期
- 传达技术文档编写人员选择、持续参与和解雇政策信息
- 提供文档季槽分配的选择条件
- 说明如何处理参与者协议违规行为和失败情形
- 持续评估导师与技术文档工程师的互动情况
- 认识利益冲突和人际问题,并在必要时更换导师
- 告知导师何时需要更多任务或项目创意
- 在计划前和计划期间与导师定期沟通
- 确保提供适当且适当的指导,尤其是在临近节假日期间
您对技术文档工程师的责任
- 让技术文档工程师知道如何、何时以及为何与组织管理员联系
- 确保技术文档工程师被引进并适当整合
- 传达组织的特定要求(例如时间、编码、沟通、许可)
- 传达组织特有的预期(例如,行为、最佳实践、可见性)
- 传达截止日期、接受标准和失败/取消政策
- 监控沟通情况,确保纠正不当行为
- 确保提前通知面临失败或被忽略的风险技术文档工程师
导师职责
这些是开源组织内部导师的职责。
对您的开源组织的责任
- 传达对可用性和互动的预期
- 在指导能力将降低时(例如家庭、健康、度假)尽早发出通知
- 在技术文档工程师遇到问题时通知他们,包括:
- 缺乏沟通、活动、可见性或进度
- 违反参与者协议的行为(例如抄袭、骚扰、欺诈)
- 不适合项目,或者降级
- 正式评估技术文档工程师的参与情况。
- 在将项目标记为失败之前,请先与组织管理员和技术文档工程师沟通
对技术文档工程师的责任
以下是您对所指导的技术文档工程师的责任:
- 帮助并/或教技术文档撰写人如何操作
- 成为你社区的一员
- 以公开透明的方式
- 使用贵组织的首选通信渠道(IRC、Slack 等)
- 使用组织的版本控制系统
- 提出优质问题并获得解答
- 提供令人信服的技术论点和建设性的讨论
- 工作积极主动,高效工作
- 解决棘手的技术问题
- 跟踪他们的进度,让技术文档工程师随时了解其状态
- 定期沟通:
- 每周至少定期沟通两次
- 在 24 小时内回复问题(有时可以在 36 小时内回复)
- 提供有建设性的反馈,保持耐心,相互尊重
- 设定切合实际的工作目标和时间表预期
- 当数据明显高于或落后于预期时,与技术文档工程师一起重新评估范围
- 与开发者和社区合作,推动技术文档工程师的工作被接受
相关信息
- 请查看技术文档撰写者的职责。
- 如需有关注册和报告相关任务的帮助,请参阅组织管理员指南和导师指南。