Files
ai/docs/work-sync/08_维护规范/DOCUMENT_TEMPLATE.md
T

1.6 KiB

Work 文档模板 V1

1. 当前设计文档模板

# <领域/系统名称> V1

> 文档状态:当前有效 / 待实现 / 部分实现 / 待验证
> 基线日期:YYYY-MM-DD
> 事实来源:代码路径、迁移、状态快照

## 1. 目标
## 2. 非目标
## 3. 当前能力
## 4. 核心对象
## 5. 主流程
## 6. 业务规则
## 7. 数据/API/队列影响
## 8. 安全与成本
## 9. 当前差距
## 10. 不可破坏规则
## 11. 下一阶段
## 12. 更新触发条件

2. FEATURE 模板

# FEATURE_<名称>_V1

> 状态:讨论中 / 已确认 / 实现中 / 已验证 / 已取消
> 关联基线:WORK_SYNC_...
> 负责人:

## 背景与问题
## 目标
## 非目标
## 用户流程
## 业务规则
## 方案
## 替代方案
## 数据库影响
## API/队列/Provider 影响
## UI 状态
## 安全、隐私与成本
## 兼容与迁移
## 验收标准
## 发布与回滚
## 未决问题

3. ADR 模板

# ADR_0001_<主题>

> 状态:提议 / 接受 / 废弃 / 被替代
> 日期:YYYY-MM-DD

## 背景
## 决策
## 替代方案
## 正面影响
## 负面影响
## 迁移与回滚
## 验证方式

4. 状态快照要求

状态快照必须包含:

  • 审计时间、对象和口径。
  • 当前架构和真实运行配置。
  • 已实现、部分实现和仅设计能力。
  • 数据库、API、队列和 Provider 统计。
  • 构建、测试和服务验证。
  • Git、备份、部署和安全风险。
  • 与上一版状态快照的差异。
  • 明确列出未执行的验证。

禁止包含任何凭据或用户明细。