| | |
|---|
| | | # 编码规范 |
|---|
| | | # 编码规范 |
|---|
| | | |
|---|
| | | 创建人员：Codex |
|---|
| | | 文件职责：定义通用编码注意事项、编码流程、验收方式、问题修复原则，适用于管理体系下的多个项目。 |
|---|
| | |
|---|
| | | |
|---|
| | | 常见映射： |
|---|
| | | |
|---|
| | | 1. 产品 / 需求开发：`dev/pro-dev/`、`dev/pro-dev/test/`、`dev-doc/pro-doc/`。 |
|---|
| | | 1. 需求 / 需求开发：`dev/pro-dev/`、`dev/pro-dev/test/`、`dev-doc/pro-doc/`。 |
|---|
| | | 2. 实验开发：`dev/exp-dev/`、`dev/exp-dev/test/`、`dev-doc/exp-doc/`。 |
|---|
| | | 3. 案例分析开发：`dev/ana-dev/`、`dev/ana-dev/test/`、`dev-doc/ana-doc/`。 |
|---|
| | | |
|---|
| | |
|---|
| | | 编码前按以下顺序执行： |
|---|
| | | |
|---|
| | | 1. 确认事项编号、任务目标、责任模块。 |
|---|
| | | 2. 阅读相关需求文档、产品方案、架构文档、模块说明文档、核心流程文档、流程图、接口文档；没有的上游文档要说明“不适用”。 |
|---|
| | | 2. 阅读相关需求文档、需求方案、架构文档、模块说明文档、核心流程文档、流程图、接口文档；没有的上游文档要说明“不适用”。 |
|---|
| | | 3. 判断本次是需求问题、代码问题、数据问题，还是流程问题。 |
|---|
| | | 4. 明确改动范围，列出会被影响的模块和产物。 |
|---|
| | | 5. 如属于多模块或长流程改动，先写代码编写方案。 |
|---|
| | | 6. 明确验收方式，包括最小样本、边界样本、失败样本、全量样本。 |
|---|
| | | 7. 再开始编码。 |
|---|
| | | |
|---|
| | | 如果本次是产品体系交付到开发的事项，还必须先读项目本地 `pro-doc/产品规范.md`、`pro-doc/需求规范.md`，以及需求文档引用的产品方案、架构文档、模块说明文档、核心流程文档。若这些上游产品文档缺失或互相冲突，应按产品/需求问题退回，不得靠代码补口径。 |
|---|
| | | 如果本次是需求体系交付到开发的事项，还必须先读项目本地 `pro-doc/需求规范.md`、`pro-doc/需求规范.md`，以及需求文档引用的需求方案、架构文档、模块说明文档、核心流程文档。若这些上游需求文档缺失或互相冲突，应按需求问题退回，不得靠代码补口径。 |
|---|
| | | |
|---|
| | | 如果本次是实验开发、案例分析开发或项目工具开发，也必须读取对应目标体系规范和事项账本；开发规范只约束怎么写代码，不替代目标体系的业务流程。 |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | 这类任务通常不需要先写需求文档，也不需要写代码编写方案。 |
|---|
| | | |
|---|
| | | 产品体系正式交付到开发的事项，默认不适用“无需求文档的轻量实现”。如果产品侧只给了口头要求或草案，应先回到产品/需求流程形成可审计需求，再进入开发。 |
|---|
| | | 需求体系正式交付到开发的事项，默认不适用“无需求文档的轻量实现”。如果需求侧只给了口头要求或草案，应先回到需求流程形成可审计需求，再进入开发。 |
|---|
| | | |
|---|
| | | 执行流程： |
|---|
| | | |
|---|
