# 开发体系目录导读

创建人员：Codex  
文件职责：说明 `common/dev-doc` 下开发体系公共规范、模板和创建指南的用途。  
管理规范/模板：../../全局规范.md；../../体系创建流程.md；编码规范.md。  
引用文件：编码规范.md；开发环境创建指南.md；开发审计规范.md；编码方案范本.md；开发事项总纲模版.md；开发事项计划模版.md；开发执行日志模版.md；开发审计报告模版.md；开发问题记录模版.md。  
记录方式：目录导读；新增、删除或调整开发体系公共文档时同步更新。

## 1. 体系定位

开发体系是项目默认自带的基础体系，但不单独承载业务目标。

开发必须绑定目标体系或目标事项，例如：

1. 需求 / 需求开发：实现需求、策略文档对应的代码。
2. 实验开发：实现实验脚本、回测、图表、数据处理和校验工具。
3. 案例分析开发：实现案例图表、账本、回放和审计辅助工具。
4. 项目工具开发：实现项目初始化、索引、归档和检查工具。

开发代码、测试和开发文档按目标体系分账，不直接堆到 `dev/` 或 `dev-doc/` 根目录。

## 2. 文件清单

| 文件 | 类型 | 职责 |
|---|---|---|
| `编码规范.md` | 全局规范 | 规定编码流程、轻重流程、编码方案要求、自检、测试、问题归因和公共模块原则 |
| `开发环境创建指南.md` | 创建指南 | 指导项目管理员为某个目标体系创建开发工作区 |
| `编码方案范本.md` | 范本 | 重型开发编码方案参考写法；不是必须复制的模板，硬性要求以 `编码规范.md` 为准 |
| `开发事项总纲模版.md` | 模板 | 项目内开发事项背景、目标、边界、状态和结论滚动账本 |
| `开发事项计划模版.md` | 模板 | 项目内开发事项计划、步骤、输入输出、验收方式和审计入口 |
| `开发执行日志模版.md` | 模板 | 项目内开发执行、关键节点、测试、自检、偏离和结果日志 |
| `开发审计规范.md` | 审计规范 | 规定开发方案审核、实现审核、测试验收和问题闭环 |
| `开发审计报告模版.md` | 模板 | 项目内开发审计报告滚动账本 |
| `开发问题记录模版.md` | 模板 | 非审计来源开发问题闭环记录 |

## 3. 推荐使用顺序

创建项目内开发工作区时：

1. 先读 `编码规范.md`。
2. 按 `开发环境创建指南.md` 创建 `dev/<target>-dev/`、`dev/<target>-dev/test/`、`dev-doc/<target>-doc/`。
3. 创建开发事项总纲、计划、执行日志、审计报告和问题记录。
4. 重型开发先按事项创建具体编码方案文件，例如 `开发方案/<CODE-DESIGN-ID>.md`，经审核通过后再写代码。
5. 开发完成后写执行日志、自测结果，并按目标体系写入对应审计报告入口。

## 4. 开发体系边界

开发体系负责：

1. 代码实现。
2. 测试代码。
3. 编码方案。
4. 开发执行日志。
5. 开发审计。
6. 开发问题闭环。

开发体系不负责：

1. 替代需求文档。
2. 替代实验设计。
3. 替代案例分析结论。
4. 替代项目事项管理。
5. 在 common 中保存具体项目代码或结果。

## 5. 问题记录口径

开发审核员发现的问题主记录写入对应审计报告入口：需求开发、项目工具开发、独立开发事项写 `开发审计报告.md`；实验开发写 `exp-doc/实验审计报告.md`；案例分析开发写 `ana-doc/案例审计报告.md`。

非审计来源的问题，例如需求 AI、实验员、案例分析员、项目管理员或人工反馈，记录到 `开发问题记录.md`。

如果问题属于需求不清、实验设计不清或案例方法不清，应明确归因并回到对应体系处理，不要只在开发体系里散修代码。