工程规范与流程
这里沉淀我们在真实项目里反复用过的规范与流程。
目标:协作可预期、交付可验收、变更可控制、系统可交接。
给客户:先读这三篇
全部文档
如何提需求
客户如何提需求:准备什么、怎么描述、模板与渠道、我们如何确认范围。
如何验收
客户如何验收:验收标准、验收步骤、缺陷分级、通过/不通过与签署。
需求变更流程
需求变更流程:何时算变更、如何提出、影响评估、确认与执行、紧急变更。
协作与需求流程(总览)
协作总览:提需求、确认范围、开发同步、验收与变更的衔接。
完成定义(DoD)
完成定义(Definition of Done):功能、接口、发布与交接怎样才算做完。
代码与评审规范
代码与评审规范:风格、提交、分支与合并门禁。
API 设计边界
API 设计边界:资源职责、错误语义、版本与扩展约定。
交付与里程碑
交付与里程碑:分期、验收门禁、风险同步与试点策略。
发布与部署
发布与部署流程:窗口、检查清单、灰度、回滚与配置纪律。
事故响应
事故响应流程:发现、止血、沟通、恢复、复盘与告警治理。
交接清单
交接清单:账号权限、文档、观测、回滚与联系人,上线后如何可接手。
文档规范
文档规范:写什么、写到什么程度、如何与版本同步、如何避免错误文档。
原则(先记住这几条)
| 原则 | 含义 |
|---|---|
| 合适优先 | 选能落地、能维护的方案,不为复杂而复杂 |
| 边界先写清 | 负责什么 / 不负责什么,比先堆功能重要 |
| 书面确认范围 | 口头可讨论,范围与变更以书面为准 |
| 验收按约定 | 验收对照已确认标准,不默认临场加需求 |
| 可回滚默认 | 变更与发布先想退路,再想冲刺 |
| 交接算交付 | 上线不是终点;文档、权限、值班路径要齐 |