调整文档

This commit is contained in:
2026-07-21 10:22:43 +08:00
parent 2d4b3cfd96
commit a7307a5a07
29 changed files with 17 additions and 80 deletions
+9
View File
@@ -57,3 +57,12 @@
- ✅ 正确:源头无法即时修复时,应**显式报错 / 校验失败**(写入自检工具、抛出明确异常),把问题暴露出来,而非隐藏。
- 判据:问"如果去掉这段代码,问题会不会暴露出来?"——若答案是"会,且暴露的是真问题",那这段就是在掩盖问题,应删除并改修根因。
- 兜底/默认值仅允许用于**合法的业务缺省**(如可选配置留空有明确语义),不得用于**遮盖本应正确配置却没配好**的情况。
## 7. 文档分区:开发文档与长期文档
开发过程中产生的文档,按用途分放两处:
- **`Docs_Dev/`** — 开发过程中的临时性 / 阶段性文档:实现计划、开发笔记、验证清单、评估报告、调试记录、一次性任务的 spec 等(会随开发推进而过时的文档)。
- **`Docs/`** — 项目长期文档:指导手册(`Docs/Guides/`)、架构设计、命名/目录/规范(`Docs/Standards/`)等需要长期维护、对项目持续有效的文档。
判据:问"这份文档在对应功能开发完成后是否还需要长期查阅?"——需要长期查阅(手册、架构、规范)放 `Docs/`;只服务于当前开发阶段的放 `Docs_Dev/`