chore(project): 初始化项目协作与知识基线

This commit is contained in:
bruce
2026-09-09 13:01:36 +08:00
parent 6d0d57561d
commit cbc1392feb
9 changed files with 129 additions and 76 deletions
@@ -0,0 +1,31 @@
---
reviewStatus: pending
reviewedAt: null
replacedBy: null
---
# 文档维护规范
## 适用范围
本规范适用于项目正式需求、生效设计、项目规范和长期知识。过程草稿按任务需要维护,不强制逐份审核;历史归档保留当时快照,不作为当前依据。
## 创建与更新
- 任务开始时查找相关已有文档,优先更新现有权威内容,不创建同义平行版本。
- 新建或实质修改长期文档后,将文档自身的 `reviewStatus` 标为 `pending`。
- 项目已有审批结果可以直接作为审核依据;通过后标为 `approved`。
- 已知文档与需求、实现或新证据不一致时标为 `outdated`;更新后回到 `pending` 并重新审核。
- 排版、错字、链接修复和不改变含义的调整不改变审核状态。
## 状态与替代
项目没有既有元数据格式时,在文档 Frontmatter 使用 `reviewStatus`、`reviewedAt` 和 `replacedBy`。旧文档缺少状态时视为尚未确认,只在实际使用或修改时补齐。
新版替代旧版时更新索引和引用,并通过 `replacedBy` 指向当前版本。旧版根据历史价值归档或删除;归档发现错误时补充勘误和新版链接,不改写历史事实。
## 任务关联与关闭
本地 `task.json` 记录本次创建、更新或引用的文档。关联旧文档不转移所有权,也不产生删除权限。
任务关闭前检查本次实现影响的长期文档已经同步。需要作为当前依据的文档必须为 `approved`;`pending` 或 `outdated` 文档应完成处理,无法处理时列入延后清单并说明影响。
+7 -6
View File
@@ -2,10 +2,11 @@
| 主题 | 适用范围 | 规则入口 | 优先级 |
| --- | --- | --- | --- |
| AI 开发流程、验证与交付 | 全仓库开发任务 | `../../docs/development-guide.md` | 项目规则 |
| 架构、模块、数据与部署边界 | 设计和实现任务 | `../../docs/architecture.md` | 项目规则 |
| Agent 契约与安全边界 | Agent、工具和评测任务 | `../../docs/agent-contract.md` | 项目规则 |
| 阶段范围与实施顺序 | 需求规划和增量实现 | `../../docs/roadmap.md` | 项目计划 |
| Python 格式与静态检查配置 | Python 源码 | `../../pyproject.toml` | 工具配置 |
| 文档生命周期 | 正式需求、设计、规范和长期知识 | [文档维护规范](document-maintenance.md) | 项目规则 |
| AI 开发流程 | 全仓库开发、验证与交付 | [AI 开发约定](../../docs/development-guide.md) | 项目规则 |
| 架构与数据边界 | 设计和实现任务 | [架构设计](../../docs/architecture.md) | 项目规则 |
| Agent 安全边界 | Agent、工具和评测任务 | [Agent 契约](../../docs/agent-contract.md) | 项目规则 |
| 阶段实施顺序 | 需求规划和增量实现 | [实施路线图](../../docs/roadmap.md) | 项目计划 |
| Python 质量配置 | Python 源码 | [工具配置](../../pyproject.toml) | 工具配置 |
未覆盖主题可由 `guidance` 查询中性公共基线。规划内容不能替代已确认的当前实现规则。
新增规范时记录主题、适用范围、规则文件和优先级;未覆盖主题可由 `guidance` 查询中性公共基线。