| | |
| | | # ana-doc 目录导读 |
| | | # ana-doc 目录导读 |
| | | |
| | | 创建人员:Codex |
| | | 文件职责:说明 `common/ana-doc` 目录下案例分析体系规范、创建指南、模板和审计文档的用途。 |
| | | 管理规范/模板:../../全局规范.md;../../体系说明.md;案例分析规范.md。 |
| | | 引用文件:案例分析规范.md;案例分析环境创建指南.md;本目录下全部 `*模版.md` 和 `*指南.md` 文件。 |
| | | 记录方式:目录入口文档;新增或删除本目录正式文档时同步更新。 |
| | | 创建人员:management.admin |
| | | 文件职责:说明 `project-info` 项目案例分析体系文档入口和相邻数据目录用途。 |
| | | 管理规范/模板:../项目规范.md;../../common/ana-doc/案例分析环境创建指南.md;../../common/ana-doc/案例分析规范.md。 |
| | | 引用文件:案例分析规范.md;案例审核规范.md;案例总纲.md;案例分析设计.md;案例执行日志.md;案例审计报告.md;案例问题记录.md;案例存储体系.md;../项目配置清单.md。 |
| | | 记录方式:目录入口文档;本目录正式文件新增、删除、改名或职责变化时同步更新。 |
| | | |
| | | ## 1. 目录定位 |
| | | ## 1. 本体系定位 |
| | | |
| | | 本目录保存通用案例分析体系。 |
| | | `project-info` 的案例分析体系用于沉淀股市信息案例,包括研报、公告、新闻、公开网络信息、K 线显影、数据证据和分析结论。案例体系只记录可复核的案例链路,不替代实验体系的可执行验证,也不直接给出交易建议。 |
| | | |
| | | 案例分析体系负责管理“基于规则、方法论、笔记、现象或样本,对具体案例做全流程复盘和证据链分析”的事项。 |
| | | ## 2. 文档入口 |
| | | |
| | | 它强调: |
| | | | 文件 | 作用 | |
| | | |---|---| |
| | | | `案例分析规范.md` | 本项目案例分析本地规范入口,引用 common 规范并说明本项目补充口径 | |
| | | | `案例审核规范.md` | 本项目案例审核本地规范入口,引用 common 审核规范并说明审核员职责 | |
| | | | `案例总纲.md` | 案例事项背景、目标、边界、状态和结论账本 | |
| | | | `案例分析设计.md` | 案例选择口径、执行步骤、证据要求和验收方式 | |
| | | | `案例执行日志.md` | 案例执行过程、关键节点、数据和证据路径 | |
| | | | `案例审计报告.md` | 初始化审计、设计审核、执行审核、复审和审计问题主记录 | |
| | | | `案例问题记录.md` | 非审计来源问题,或审计问题跨轮索引 | |
| | | | `案例存储体系.md` | 案例数据、证据、图片、结果包和临时文件存储口径 | |
| | | |
| | | 1. 起因和原始要求必须留痕。 |
| | | 2. 案例选择、判断、操作、结果必须能追踪。 |
| | | 3. 关键步骤要有数据或图片证据。 |
| | | 4. 审核员能按证据链复核每一步是否对得上。 |
| | | ## 3. 数据目录 |
| | | |
| | | ## 2. 文件清单 |
| | | | 目录 | 作用 | |
| | | |---|---| |
| | | | `../ana-data/cases/` | 案例级结构化数据和逐案例证据目录 | |
| | | | `../ana-data/result/` | 正式结果包、汇总表、审计辅助输出 | |
| | | | `../ana-data/img/` | 案例图片、图册、标注图和图片 manifest | |
| | | | `../ana-data/tmp/` | 临时数据和中间产物,不得作为正式证据入口 | |
| | | |
| | | | 文件 | 类型 | 作用 | |
| | | |---|---|---| |
| | | | 案例分析规范.md | 全局规范 | 定义案例分析体系定位、流程、证据链、边界和问题闭环 | |
| | | | 案例分析环境创建指南.md | 创建指南 | 指导项目管理员在项目内创建案例分析环境 | |
| | | | 案例存储体系创建指南.md | 创建指南 | 指导案例数据、图片、账户/过程表、结果包如何存储和索引 | |
| | | | 案例总纲模版.md | 模板 | 创建项目级案例总账本,记录案例背景、目标、方法论来源和当前结论 | |
| | | | 案例分析设计模版.md | 模板 | 创建项目级案例分析设计账本,记录案例选择口径、全流程步骤和验收方式 | |
| | | | 案例执行日志模版.md | 模板 | 创建项目级案例执行日志,记录每个案例关键节点、数据和结果 | |
| | | | 案例审核规范.md | 审核规范 | 定义案例设计审核、执行审核、证据链审核和阻断标准 | |
| | | | 案例审计报告模版.md | 模板 | 创建项目级案例审计报告,记录审核结果、问题和是否通过 | |
| | | | 案例问题记录模版.md | 模板 | 创建非审计来源案例问题闭环账本;审计问题只做索引 | |
| | | ## 4. 当前案例入口 |
| | | |
| | | ## 3. 推荐使用顺序 |
| | | | 案例 ID | 名称 | 状态 | 入口 | |
| | | |---|---|---|---| |
| | | | `ANA-SMOKE-001` | 案例体系初始化 dry-run | 初始化完成,待审核员复核 | `案例总纲.md`、`案例分析设计.md`、`案例执行日志.md`、`案例审计报告.md` | |
| | | |
| | | 项目启用案例分析体系时: |
| | | |
| | | 1. 先读 `../../全局规范.md`。 |
| | | 2. 再读 `../../体系说明.md`。 |
| | | 3. 读 `案例分析规范.md`。 |
| | | 4. 按 `案例分析环境创建指南.md` 创建项目内 `ana-doc/`、`ana-data/` 和本地规范。 |
| | | 5. 如案例涉及图片、表格、交易流水、过程数据,按 `案例存储体系创建指南.md` 创建存储结构。 |
| | | 6. 用模板创建案例总纲、案例分析设计、案例执行日志、案例审计报告和案例问题记录。 |
| | | 7. 每个案例按设计执行并写执行日志。 |
| | | 8. 审核员按 `案例审核规范.md` 做设计审核和执行审核。 |
| | | |
| | | 所有案例分析文档默认采用 append-only 方式维护:最新案例、执行、审计和问题记录追加到对应文件末尾。审核员发现的问题主记录写入案例审计报告;案例问题记录只承接非审计问题或审计问题索引。 |
| | | 新增正式案例时,应先在 `案例总纲.md` 登记,再在 `案例分析设计.md` 补设计;设计审核通过后才能执行。 |