文档生命周期管理规范

版本: 1.0
生效日期: 2026-04-04
适用范围: 知识库 V2 所有文档

🎯 目标

建立标准化的文档生命周期管理流程，确保知识库内容：

✅ 及时更新（不过时）
✅ 有序归档（不混乱）
✅ 质量可控（不低质）

📊 文档状态流转

┌─────────┐    审查通过    ┌─────────────┐    归档条件    ┌─────────┐
│  draft  │ ────────────→ │  published  │ ────────────→ │ archived│
│  草稿   │               │   已发布    │               │  已归档  │
└─────────┘               └─────────────┘               └─────────┘
     ↑                           ↑                           ↑
     │                           │                           │
     └─────── 驳回修改 ──────────┘                           │
                                                             │
                     ┌───────────────────────────────────────┘
                     │
                     └─────── 重新激活 ────────→ published

1️⃣ 新建触发条件

1.1 按文档类型分类

文档类型	目录	新建触发条件
项目文档	`knowledge/projects/`	新任务/项目启动
研究报告	`knowledge/reports/`	新报告生成完成
协议规范	`knowledge/protocols/`	新架构/流程确立
配置指南	`guides/`	新系统/功能配置完成
故障排除	`troubleshooting/`	新问题排查解决
参考资料	`reference/`	外部参考信息整理
归档内容	`knowledge/archives/`	文档归档时移动

1.2 新建流程

1. 确定文档类型 → 选择目标目录
       ↓
2. 复制模板文件 → `docs/templates/note-template.md`
       ↓
3. 填写 Frontmatter → id/timestamp/access_level/status/tags
       ↓
4. 编写文档内容 → 遵循内容规范
       ↓
5. 运行 Schema 验证 → `node scripts/validate-schema.js`
       ↓
6. 提交至 draft 分支 → 创建 PR
       ↓
7. 审查通过 → 合并至 main → 状态改为 published

2️⃣ 更新规范

2.1 更新触发条件

场景	操作
内容过时/错误	立即更新 + 更新 timestamp
新增相关信息	追加内容 + 更新 timestamp
链接失效	修复链接 + 更新 timestamp
标签不准确	调整 tags + 更新 timestamp
关联新文档	添加内部链接 + 更新 timestamp

2.2 更新流程

1. 修改文档内容
       ↓
2. 更新 Frontmatter.timestamp → ISO-8601 格式
       ↓
3. 运行 Schema 验证
       ↓
4. 提交至 update/* 分支 → 创建 PR
       ↓
5. 审查通过 → 合并至 main

2.3 版本标记

重大更新 需在文档末尾添加更新记录：

markdown

---

## 📝 更新记录

### v1.1 (2026-04-05)
- 新增 XXX 章节
- 修复 XXX 错误

### v1.0 (2026-04-04)
- 初始版本

3️⃣ 归档标准

3.1 强制归档条件（满足任一即归档）

条件	说明	示例
项目结束	项目验收通过 + 无后续维护	ClawTeam V5.0 阶段 1 完成 → 归档
内容过时	超过 90 天未更新 + [STALE] 标记≥3	旧版 UI 配置指南
被替代	新版本协议/规范发布	V1-PROTOCOL.md → V2-PROTOCOL.md 发布后归档 V1
临时文档	临时任务/测试文档	测试报告、临时配置

3.2 可选归档条件（酌情处理）

条件	说明
参考价值低	内容过于具体/场景化，无通用价值
信息不完整	文档未完成且无继续完善计划
重复内容	与其他文档高度重复

4️⃣ 归档流程

4.1 标准归档流程

1. 确认归档条件 → 填写归档原因
       ↓
2. 修改 Frontmatter:
   - status: archived
   - 添加 archived_date: 2026-04-04
   - 添加 archived_reason: 项目结束/内容过时/被替代
       ↓
3. 移动文件至 archives/ 目录
       ↓
4. 在原文档顶部添加归档说明框
       ↓
5. 更新相关文档的内部链接 → 指向新归档位置
       ↓
6. 提交至 update/* 分支 → 创建 PR
       ↓
7. 合并至 main

4.2 归档说明框格式

markdown

> [!ARCHIVED]
> **归档日期:** 2026-04-04  
> **归档原因:** 项目结束  
> **替代文档:** [V2-PROTOCOL.md](./V2-PROTOCOL.md)  
> **最后更新:** 2026-04-01

4.3 归档文档管理

目录结构：

knowledge/archives/
├── 2026/
│   ├── 2026-04/
│   │   └── 旧项目文档.md
│   └── 2026-03/
└── index.md (归档索引)

归档索引要求：

按年份/月份组织
每篇归档文档必须说明归档原因
如有替代文档，必须添加链接

5️⃣ 重新激活流程

5.1 重新激活条件

场景	说明
项目重启	归档项目重新启动
内容更新	归档文档需要补充新信息
参考需求	归档文档被频繁引用

5.2 重新激活流程

1. 从 archives/ 移动回原目录
       ↓
2. 修改 Frontmatter:
   - status: published
   - 删除 archived_date/archived_reason
   - 更新 timestamp
       ↓
3. 更新内容 → 补充新信息
       ↓
4. 提交至 update/* 分支 → 创建 PR
       ↓
5. 合并至 main

📋 质量检查清单

新建文档检查

[ ] Frontmatter 完整（id/timestamp/access_level/status/tags）
[ ] 内容符合模板规范
[ ] 内部链接有效
[ ] Schema 验证通过
[ ] 已添加"相关文档"章节

更新文档检查

[ ] timestamp 已更新
[ ] 更新记录已添加（重大更新）
[ ] 内部链接已修复
[ ] Schema 验证通过

归档文档检查

[ ] 归档原因明确
[ ] 替代文档链接（如有）
[ ] 归档说明框已添加
[ ] 相关文档链接已更新
[ ] 已移动至 archives/ 目录

🔗 相关文档

知识关联规范 — 内部链接与标签体系
审查周期规范 — 定期审查机制
V2-PROTOCOL.md — 知识库 V2 架构协议

最后更新: 2026-04-04
状态: ✅ 已发布

文档生命周期管理规范 ​

🎯 目标 ​

📊 文档状态流转 ​

1️⃣ 新建触发条件 ​

1.1 按文档类型分类 ​

1.2 新建流程 ​

2️⃣ 更新规范 ​

2.1 更新触发条件 ​

2.2 更新流程 ​

2.3 版本标记 ​

3️⃣ 归档标准 ​

3.1 强制归档条件（满足任一即归档） ​

3.2 可选归档条件（酌情处理） ​

4️⃣ 归档流程 ​

4.1 标准归档流程 ​

4.2 归档说明框格式 ​

4.3 归档文档管理 ​

5️⃣ 重新激活流程 ​

5.1 重新激活条件 ​

5.2 重新激活流程 ​

📋 质量检查清单 ​

新建文档检查 ​

更新文档检查 ​

归档文档检查 ​

🔗 相关文档 ​

文档生命周期管理规范

🎯 目标

📊 文档状态流转

1️⃣ 新建触发条件

1.1 按文档类型分类

1.2 新建流程

2️⃣ 更新规范

2.1 更新触发条件

2.2 更新流程

2.3 版本标记

3️⃣ 归档标准

3.1 强制归档条件（满足任一即归档）

3.2 可选归档条件（酌情处理）

4️⃣ 归档流程

4.1 标准归档流程

4.2 归档说明框格式

4.3 归档文档管理

5️⃣ 重新激活流程

5.1 重新激活条件

5.2 重新激活流程

📋 质量检查清单

新建文档检查

更新文档检查

归档文档检查

🔗 相关文档