32 lines
1.6 KiB
Markdown
32 lines
1.6 KiB
Markdown
---
|
||
reviewStatus: pending
|
||
reviewedAt: null
|
||
replacedBy: null
|
||
---
|
||
|
||
# 文档维护规范
|
||
|
||
## 适用范围
|
||
|
||
本规范适用于项目正式需求、生效设计、项目规范和长期知识。过程草稿按任务需要维护，不强制逐份审核；历史归档保留当时快照，不作为当前依据。
|
||
|
||
## 创建与更新
|
||
|
||
- 任务开始时查找相关已有文档，优先更新现有权威内容，不创建同义平行版本。
|
||
- 新建或实质修改长期文档后，将文档自身的 `reviewStatus` 标为 `pending`。
|
||
- 项目已有审批结果可以直接作为审核依据；通过后标为 `approved`。
|
||
- 已知文档与需求、实现或新证据不一致时标为 `outdated`；更新后回到 `pending` 并重新审核。
|
||
- 排版、错字、链接修复和不改变含义的调整不改变审核状态。
|
||
|
||
## 状态与替代
|
||
|
||
项目没有既有元数据格式时，在文档 Frontmatter 使用 `reviewStatus`、`reviewedAt` 和 `replacedBy`。旧文档缺少状态时视为尚未确认，只在实际使用或修改时补齐。
|
||
|
||
新版替代旧版时更新索引和引用，并通过 `replacedBy` 指向当前版本。旧版根据历史价值归档或删除；归档发现错误时补充勘误和新版链接，不改写历史事实。
|
||
|
||
## 任务关联与关闭
|
||
|
||
本地 `task.json` 记录本次创建、更新或引用的文档。关联旧文档不转移所有权，也不产生删除权限。
|
||
|
||
任务关闭前检查本次实现影响的长期文档已经同步。需要作为当前依据的文档必须为 `approved`；`pending` 或 `outdated` 文档应完成处理，无法处理时列入延后清单并说明影响。
|