这里是 EESAST 微信小程序的规范化文档入口。
| 目录 / 文件 | 用途 | 更新方式 |
|---|---|---|
| architecture/ | 当前系统架构、目录边界、运行时数据流和非目标 | 随实现状态更新 |
| adr/ | 已采纳的架构决策及其取舍 | 只新增,不改写已采纳决策 |
| releases/CHANGELOG.md | 面向使用者的版本变化 | 每次版本变化追加 |
| VERSION.md | 当前版本、版本状态和版本规则 | 发布或主线行为变化时更新 |
| TESTING.md | 开发者工具、真机和发布前验收 | 测试流程变化时更新 |
架构文档描述「现在是什么」,ADR 描述「为什么这样做」,变更日志描述「版本带来了什么」,测试清单描述「如何验证」。调研过程、临时方案和已废弃内容不再放在单一设计文档中。
新增文档时:
- 先判断它属于架构、决策、版本还是验收。
- 在对应目录使用已有命名规则。
- 在相关文档中添加反向链接。
- 代码行为和文档冲突时,以代码和自动化校验结果为准,并补充文档修正。