| | |
| | | # exp-doc 目录导读 |
| | | # exp-doc 目录导读 |
| | | |
| | | 创建人员:Codex |
| | | 文件职责:说明 `common/exp-doc` 目录下实验规范和实验模板文档的用途。 |
| | | 管理规范/模板:../../管理系统说明.md;../../体系说明.md;common/exp-doc/实验规范.md。 |
| | | 引用文件:实验规范.md;本目录下全部 `*模版.md` 文件。 |
| | | 创建人员:management.admin |
| | | 文件职责:说明 `project-info` 项目实验体系文档入口和相邻数据目录用途。 |
| | | 管理规范/模板:../项目规范.md;../../common/exp-doc/实验环境创建指南.md;../../common/exp-doc/实验规范.md。 |
| | | 引用文件:实验规范.md;实验审计规范.md;实验存储体系.md;实验总纲.md;实验设计.md;实验执行日志.md;实验审计报告.md;实验问题记录.md;../项目配置清单.md。 |
| | | 记录方式:目录入口文档;本目录正式文件新增、删除、改名或职责变化时同步更新。 |
| | | |
| | | ## 1. 目录定位 |
| | | ## 1. 本体系定位 |
| | | |
| | | 本目录保存通用实验体系规范和实验体系模板。 |
| | | `project-info` 的实验体系用于对股市信息分析中的假设、数据口径、K 线统计、研报/新闻规则和信息拓扑方法做可复核验证。实验体系只输出实验结果和边界,不替代案例体系的案例叙事,也不直接给出交易建议。 |
| | | |
| | | `实验规范.md` 是体系说明文件,不是模板。 |
| | | ## 2. 文档入口 |
| | | |
| | | `*模版.md` 文件用于新项目或新实验事项创建时实例化对应实验文档。 |
| | | | 文件 | 作用 | |
| | | |---|---| |
| | | | `实验规范.md` | 本项目实验员必须遵守的本地规范入口 | |
| | | | `实验审计规范.md` | 本项目实验审核员必须遵守的本地审核规范入口 | |
| | | | `实验审核规范.md` | common 审核规范的项目副本/兼容入口;优先使用 `实验审计规范.md` | |
| | | | `实验存储体系.md` | 实验数据、结果包、图片、日志和 schema 的存储口径 | |
| | | | `实验总纲.md` | 实验事项背景、目标、边界、状态和结论账本 | |
| | | | `实验设计.md` | 实验设计、步骤、依赖、产物和判定标准 | |
| | | | `实验执行日志.md` | 实验 run、输入、关键过程、输出、异常、自检和重跑记录 | |
| | | | `实验审计报告.md` | 设计审核、执行审核、复审和审计问题主记录 | |
| | | | `实验问题记录.md` | 非审计来源实验问题,审计问题只做索引 | |
| | | |
| | | ## 2. 文件清单 |
| | | ## 3. 数据目录 |
| | | |
| | | | 文件 | 类型 | 作用 | |
| | | |---|---|---| |
| | | | 实验规范.md | 体系规范 | 说明实验体系核心流程、文档职责和审计闭环 | |
| | | | 实验环境创建指南.md | 创建指南 | 指导 AI 在项目中创建完整实验员工作环境 | |
| | | | 实验总纲模版.md | 模板 | 创建项目级实验总纲滚动账本 | |
| | | | 实验设计模版.md | 模板 | 创建项目级实验设计滚动账本 | |
| | | | 实验执行日志模版.md | 模板 | 创建项目级实验执行日志滚动账本 | |
| | | | 实验存储体系创建指南.md | 创建指南 | 指导项目创建实验存储体系文档、数据目录、schema 和读取规则 | |
| | | | 实验审核规范.md | 审核规范 | 定义实验设计审核、执行审核、复审和审计报告记录规则;项目内应实例化为 `实验审计规范.md` | |
| | | | 实验审计报告模版.md | 模板 | 创建项目级实验审计报告滚动账本 | |
| | | | 实验问题记录模版.md | 模板 | 创建项目级实验非审计问题闭环滚动账本;审计问题只做索引 | |
| | | | 目录 | 作用 | |
| | | |---|---| |
| | | | `../exp-data/raw/` | 实验原始输入索引、抽样数据或外部文件引用 | |
| | | | `../exp-data/result/` | 正式结果包、manifest、summary、readout 和中间可复核产物 | |
| | | | `../exp-data/img/` | 实验图片、图表和图片 manifest | |
| | | | `../exp-data/tmp/` | 临时数据,不得作为正式证据入口 | |
| | | |
| | | ## 3. 使用顺序 |
| | | ## 4. 当前实验入口 |
| | | |
| | | 创建正式实验事项时,建议顺序: |
| | | | 实验 ID | 名称 | 状态 | 入口 | |
| | | |---|---|---|---| |
| | | | `EXP-SMOKE-001` | 实验体系初始化 dry-run | 初始化完成,待审核员复核 | `实验总纲.md`、`实验设计.md`、`实验执行日志.md`、`实验审计报告.md` | |
| | | |
| | | 1. 先按 `实验环境创建指南.md` 在项目中创建实验环境。 |
| | | 2. 用 `实验总纲模版.md` 创建项目级实验总纲。 |
| | | 3. 用 `实验设计模版.md` 创建项目级实验设计。 |
| | | 4. 设计审核通过后执行实验。 |
| | | 5. 用 `实验执行日志模版.md` 记录执行。 |
| | | 6. 将结果包入口回写到实验总纲和实验设计。 |
| | | 7. 按 `实验存储体系创建指南.md` 建立或更新项目内 `实验存储体系.md`,并按该体系归档结果资产。 |
| | | 8. 按 common `实验审核规范.md` 和项目本地 `实验审计规范.md` 审核设计和执行,并用 `实验审计报告模版.md` 创建或更新项目 `实验审计报告.md`。 |
| | | 9. 非审计来源问题用 `实验问题记录模版.md` 处理闭环;审计员发现的问题主记录写入实验审计报告,必要时在问题记录中建索引。结论回写记录到实验总纲和审计报告。 |
| | | |
| | | 项目实验入口不再强制使用单独导读或总纲列表模板;AI 直接读取实验总纲即可。项目如果已有总索引,可在总索引里放实验总纲入口。 |
| | | |
| | | 所有项目级实验文档默认采用 append-only 方式维护:最新实验、最新设计、最新 run、最新审计和最新问题记录都追加到对应文件末尾。 |
| | | 新增正式实验时,应先写 `实验总纲.md` 和 `实验设计.md`;设计审核通过后才能执行,执行完成后必须提交执行审核。 |