Skip to content

Commit 655b209

Browse files
committed
docs(standard): documentation.md 新增文档归档章节
1 parent f2f3b75 commit 655b209

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

‎docs/standards/documentation.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,18 @@
146146
- **有示例** — 代码示例胜过千言万语
147147
- **有结构** — 标题层级清晰,可快速定位
148148

149+
### 第七部分:文档归档
150+
151+
**归档定义**:已实施完成、不再活跃维护的文档,移入 `docs/archive/YYYY-MM-DD/` 快照(`git mv` 保留文件历史)。
152+
153+
**判定标准**:可归档 = 已落地实施的方案/设计文档、已验收的实施文档、已验证的知识卡(索引标 `[ ] 已归档`)、被取代的 ADR、已发布版本的规划文档、已执行的 spec/plan;不归档 = standards/、templates/、`knowledge/index.md`、生效 ADR、CHANGELOG、README、versions/ 内容。
154+
155+
**流程(日收工,< 15 分钟)**:① 整理昨日归档 tech-debt.md(已偿标 closed,未偿继承 carried)② 扫描今日提交登记新债务 ③ `git mv` 已实施文档入今日归档夹 ④ 写当日 README 索引 ⑤ 更新活跃区索引(链接改指归档路径 + 标 `[ ] 已归档`)⑥ 原子提交。
156+
157+
**只读约束**:技术债只认最新归档的 tech-debt.md;除最新一日外归档文件禁止修改。
158+
159+
详见 [归档机制说明](../archive/README.md)。
160+
149161
## 检查清单
150162

151163
- [ ] README 包含快速开始指南

0 commit comments

Comments
 (0)