首页 / .
docs 目录说明与记录纪律
本目录是唯一的需求与变更记录中心。自 2026-10-15 起,所有需求、修改、新增必须在此留痕。
一、硬性纪律(每次会话都必须遵守)
- 提需求即入账:用户提出的任何需求,先写入
需求台账.md(分配REQ-xxx编号),再动手。 - 改动即留痕:每一次文件新增或修改,必须在
变更日志.md追加一条(日期 / 需求号 / 改了什么 / 验证结果 / 是否已部署)。 - 方案即记录:有取舍的技术选型(例如"知识库放根 docs 还是子仓"),写入
决策记录.md,注明选项、结论、理由。 - 同步原则:源码或知识库发生变动时,
代码解析/文档、索引 TSV、HTML 站点三者的同步关系必须记入变更日志。 - 不覆盖历史:只追加,不删改既有记录;结论变了就新增一条并注明替代关系。
二、目录约定
docs/
├── README.md ← 本文件:记录纪律 + 目录约定
├── 需求台账.md ← 需求清单(REQ-xxx),需求原文 + 拆解 + 状态
├── 变更日志.md ← 每次改动的流水账
├── 决策记录.md ← 技术选型与取舍(ADR)
├── knowledge/ ← 知识库(代码解析 + 索引 + 故障速查) 〔待确认落位〕
└── output/ ← 交付物(任务清单、HTML、报告)
├── 任务清单-知识库-Skill-网站-飞书.md
└── skill-ems.html
三、当前工程的两个事实(已核实,2026-10-15)
| 目录 | 内容 | 结论 |
|---|---|---|
platform-ems-3-6/ | 264 个 .c 全部为加密二进制(file 判定为 data,首字节 340 250 221 347...),不可读 | 不是知识库源码基准 |
platform-ems-3-6-plain/ | 264 个 .c 全部为可读明文源码,CRLF | 是知识库源码基准 |
两份 git HEAD 相同:04e72700,版本 V0.11.676。
四、待补充
- 知识库统一落位目录(根
docs/knowledge/还是留在platform-ems-3-6-plain/docs/代码解析/)——见任务清单 Q2。