Skip to content

Commit a825c65

Browse files
committed
docs(archive): 归档机制说明(判定标准/SOP/债务滚动/只读约束)
1 parent 324d5fb commit a825c65

1 file changed

Lines changed: 66 additions & 0 deletions

File tree

‎docs/archive/README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# 文档归档机制
2+
3+
> 唯一权威入口:归档判定标准、日收工 SOP、技术债滚动规则、只读约束。
4+
> 关联:[文档编写规范](../standards/documentation.md)、[技术债务管理](../standards/tech-debt.md)、[归档模板](../templates/archive-template.md)。
5+
6+
## 目的
7+
8+
为已实施完成的文档提供"生命终态"去向:按天快照(`YYYY-MM-DD` 子文件夹)、git mv 保留历史、不可变可追溯。
9+
10+
## 目录结构
11+
12+
```
13+
docs/archive/
14+
├── README.md # 本说明 + 归档日期索引
15+
├── 2026-08-10/ # 某日归档
16+
│ ├── README.md # 当日索引:归档清单 + 债务摘要
17+
│ ├── tech-debt.md # 当日权威债务清单(滚动)
18+
│ └── ...已实施文档快照
19+
```
20+
21+
## 归档对象判定
22+
23+
**可归档(生命终态)**:已落地实施的方案/设计文档、已验收的实施文档、已验证的知识卡(索引标 `[ ] 已归档`)、被取代的 ADR、已发布版本的规划文档、已执行的 spec/plan。
24+
25+
**不归档(持续活跃)**:standards/、templates/、knowledge/index.md、当前生效 ADR、CHANGELOG、README、versions/ 内容(按版本粒度独立沉淀,与本品并行不重叠)。
26+
27+
**判定核心**:内容已实施完成、不再需要活跃维护 → 归档。归档时同步更新活跃区索引。
28+
29+
## 日收工归档 SOP(每个工作日,< 15 分钟)
30+
31+
1. **整理昨日债务**:读 `docs/archive/<昨日>/tech-debt.md`,逐条核对(代码/提交验证):已偿 → closed(注偿还提交);未偿 → 继承为 carried
32+
2. **识别今日新债务**:扫描今日提交中的 TODO/FIXME/HACK、妥协方案 → 登记 open
33+
3. **筛选今日已实施文档**:`git log --since=<今日>` 筛 docs 变更 → 按判定标准 → 先确认待归档文档已入库(git 跟踪)再 `git mv` 入今日归档夹(保留历史链)
34+
4. **写当日 README**:归档清单 + 债务摘要
35+
5. **更新活跃区索引**:链接改指归档路径 + 标 `[ ] 已归档`
36+
6. **原子提交**:`docs(archive): archive YYYY-MM-DD`;add 时列出归档夹与涉及文件,禁止 `-A` 目录级 add 波及未跟踪文件
37+
38+
首次归档(基线)无昨日清单可整理,跳过第 1 步。
39+
40+
## 技术债滚动规则
41+
42+
- 任何时刻,债务状态以**最新一日**归档的 `tech-debt.md` 为唯一权威;旧归档仅历史追溯
43+
- 昨日未偿债务今日保留为 `carried`(只写 ID + 一行摘要,表格列类型/优先级/来源归档照抄首次登记值,全文以首次登记日为准)
44+
- 无新增债务的归档日,仍须继承昨日清单("最新归档必有权威清单")
45+
- 编号沿用 TD-XXX,类型沿用四类分类(有意/无意/环境变化/腐化),字段:`来源归档`、`状态`(open/carried/closed)
46+
47+
## 只读约束
48+
49+
| 约束 | 保证 |
50+
|------|------|
51+
| 技术债只认最新归档 | 上方滚动规则 |
52+
| 旧归档仅可阅读已达成内容 | 除最新一日外禁止修改归档文件;归档与提交原子化,git 历史可审计 |
53+
| 时间戳命名 | `YYYY-MM-DD`;空白日不建夹 |
54+
55+
## 首次基线执行备忘(2026-08-10)
56+
57+
基线归档首次执行发现两处偏差,机制条款已同步防再犯:
58+
59+
- 3 份计划文档(biolum 设计/实施、机制实施计划)归档前未入库,`git mv` 退化为普通移动、无法保留历史 → 已按 A-1 补充"先入库再 mv"
60+
- `git add -A docs/superpowers` 将 2 份 08-07 计划(deepsea-life-elements-design、payment-phase1)连带入库,位置未变但混入归档提交 → 已按 A-2 补充"精确 add"
61+
62+
## 归档索引
63+
64+
| 归档日期 | 内容摘要 | 未偿债务 |
65+
|----------|---------|----------|
66+
| 2026-08-10 | 基线归档:性能优化/笔记创新/生物发光实施文档 + biolum 设计实施计划 + 本机制 spec | 1(TD-001) |

0 commit comments

Comments
 (0)