文档

探索

向客户询问其目标、系统、规则和流程,并将答案写入一份发现文档中,后续所有阶段都会用到该文档。

在修改任何设置之前,先了解客户的需求。将答案写入一份文档,即发现文档。后续所有阶段都会用到它,交接说明也会引用该文档内容。

沟通对象

  • 代表客户做决策并在CoRoid中负责整个组织的人。
  • CoRoid将要接入的每个代码库的工程负责人。
  • 目前负责审核和合并拉取请求的人员。
  • 当客户对数据、模型或审批有相关规则时,涉及到的安全和合规要求。
  • 工作流所覆盖的每个业务流程的所有者。

需要询问的问题

询问客户的预期成果和顾虑,而非具体设置。比如客户说“没有审核流程,没人能修改支付相关代码”,你之后再去找对应的设置即可。

目标

  • 90天后必须实现哪些改变?请获取对应的衡量指标及其当前数值,例如“支持报表功能的漏洞需在一周内修复”。
  • CoRoid必须先完成哪些工作?绝对不能做哪些工作?
  • 现在谁会提交工作任务?将来谁会向CoRoid提交工作任务?

系统

  • 使用哪个Git托管平台和代码库?CoRoid能否通过公网访问该Git托管平台?
  • 每个代码库的构建和测试方式是什么?测试需要依赖哪些服务?
  • 目前人们的登录方式是什么?公司是否使用了与SSO兼容的身份提供商?
  • 团队使用的是哪种聊天工具?
  • 目前工作任务来自哪里:问题追踪器、错误追踪器、客服收件箱还是监控工具?
  • 代理需要读取或修改哪些内部系统?是否有对应的MCP服务器?
  • 代码如何上线生产环境?由谁部署,部署日期是何时?

规则

  • 数据必须存储在何处?对AI模型的调用是否必须限制在欧盟境内?
  • 允许使用哪些模型供应商?客户是否与模型供应商签订了专属合同并拥有对应密钥?
  • 哪些代码在合并前需要指定人员的审批?审批人是谁?
  • 每项变更必须通过哪些检查:测试、覆盖率检测、安全扫描、翻译校验?
  • CoRoid无需人工干预就能启动哪些任务?每周或每月的预算上限是多少?
  • 审计日志需要记录哪些内容?需要保存多久?

流程

  • 工作流可以覆盖哪些业务流程?针对每个流程:触发条件是什么、包含哪些步骤、哪些决策需要人工介入?
  • 其余规则是什么?将其整理为条目:“当满足某条件时,执行某操作”。
  • 出现异常情况时该如何处理?比如任务失败或部署失败。
  • 哪些工作需要按日程执行?比如每周的清理任务。

人员

  • 谁是所有者和管理员?谁负责提交工作任务,谁仅负责审核?
  • 交接后谁来维护相关配置?

发现文档

保持文档简洁。按以下顺序使用这些章节。

  1. 目标。90天后的预期成果,每项成果都附有其当前衡量指标和数值。
  2. 系统。Git托管平台、代码库、登录方式、聊天工具、问题和错误追踪器、内部工具以及上线生产的方式。
  3. 规则。数据存储位置、允许的模型类型、审批要求、每项变更必须通过的检查、预算、审计和留存要求。
  4. 需覆盖的流程。针对每个项目和每个工作流:其覆盖范围、所有者是谁,以及如何确认其运行正常。
  5. 人员。人员在CoRoid中的角色,以及交接后谁来维护相关配置。
  6. 待解决问题客户仍需决定的事项及截止时间。

针对每条规则,写明其设置位置。配置会列出所有设置位置。没有对应设置的规则即为向CoRoid提出的请求。详见未被覆盖的需求。

完成条件

客户阅读并认可该文档后,任何计划变更需先更新到文档中,再同步到设置里。