docs: consolidate current project documentation

This commit is contained in:
2026-05-29 01:01:51 +08:00
parent 0b7a875ba8
commit 16cac0e292
75 changed files with 410 additions and 23951 deletions
+8 -19
View File
@@ -1,6 +1,6 @@
# 文档治理约定
最后更新:2026-04-25
最后更新:2026-05-28
## 1. 目标
@@ -41,8 +41,8 @@
- `*_EXPERIMENT_*`
- 临时工作笔记
6. `docs/archive/`
默认只作为历史参考,不作为现行事实来源
6. 已删除历史材料
旧 archive、实验记录和阶段计划已从当前文档树移除;需要追溯时使用 Git 历史
## 3. 文档分类
@@ -68,7 +68,7 @@
### 3.3 历史文档
满足以下任一条件时,应优先考虑归档到 `docs/archive/`
满足以下任一条件时,应优先考虑删除;确需保留时才放入专门的历史目录
- 已被更新文档明确取代
- 描述的是已结束阶段
@@ -91,20 +91,9 @@
`docs/` 根目录用于放当前仍有导航价值的正式文档。
### 4.3 `docs/archive/`
### 4.3 历史材料
`docs/archive/` 用于放:
- 已退役设计
- 已完成修复的过程文档
- 旧版方案
- 只保留追溯价值的材料
当归档材料数量继续增长时,应维护:
- `docs/archive/INDEX.md`
用于提供历史文档的结构化入口。
默认不再长期堆积 `docs/archive/`。被当前实现取代的设计、计划、TODO 和实验记录应删除,让 Git 历史承担追溯职责。只有外部审计、交付或合规确实要求保留的历史材料,才单独建立历史目录并维护索引。
## 5. 命名规则
@@ -148,7 +137,7 @@
- 新的正式文档进入 `docs/` 根目录时,必须决定是否加入 `docs/INDEX.md`
- 文档失效时,必须从“当前有效”区移除
- 被取代文档如仍需保留,应移动到 `docs/archive/`
- 被取代文档默认删除;确需保留时必须说明保留原因并同步索引
## 7. 语言与编码规则
@@ -190,6 +179,6 @@
后续文档清理建议按以下顺序推进:
1. 保持 `README.md``docs/INDEX.md` 为主导航入口
2. 明确失效的阶段性文档继续迁入 `docs/archive/`
2. 删除明确失效的阶段性文档
3. 收紧 `docs/` 根目录,只保留当前仍需导航的文档
4. 逐步减少无明确角色的过程型文件