# 一致性校验清单 > 跨文档对齐的半自动校验清单 --- ## 1. 需求追溯 ### 1.1 覆盖检查 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | RT-001 | 所有功能需求都有模块分配 | ⬜ | | | RT-002 | 所有非功能需求在规范中已处理 | ⬜ | | | RT-003 | 无孤立需求(未分配) | ⬜ | | | RT-004 | 无孤立功能(无需求引用) | ⬜ | | ### 1.2 可追溯矩阵 ``` 需求 → 模块 → 设计 → 规范 ``` **验证步骤:** 1. 列出 requirements-spec.md 中的所有 FR-* 编号 2. 检查每个 FR 至少出现在一个模块的需求映射中 3. 验证每个模块设计引用其覆盖的需求 4. 确认规范处理了所有非功能需求 --- ## 2. API 一致性 ### 2.1 端点覆盖 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | API-001 | 所有模块端点出现在后端规范中 | ⬜ | | | API-002 | 请求/响应 Schema 与模块设计匹配 | ⬜ | | | API-003 | 错误码在各模块间一致 | ⬜ | | | API-004 | 认证要求一致 | ⬜ | | ### 2.2 Schema 对齐 **交叉检查:** - 模块设计 API 契约 ↔ 后端规范 API 标准 - 字段名称和类型匹配 - 校验规则一致 - 错误响应格式匹配规范 ### 2.3 API 端点矩阵 | 模块 | 端点 | 在后端规范中 | Schema 匹配 | |------|------|--------------|-------------| | MOD-001 | | ⬜ | ⬜ | | MOD-002 | | ⬜ | ⬜ | --- ## 3. 数据模型一致性 ### 3.1 实体对齐 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | DM-001 | 模块设计中的所有实体出现在数据库规范中 | ⬜ | | | DM-002 | 设计与数据库规范间的字段类型匹配 | ⬜ | | | DM-003 | 关系定义一致 | ⬜ | | | DM-004 | 校验规则匹配(模块设计 ↔ 数据库约束) | ⬜ | | ### 3.2 实体交叉引用 | 实体 | 模块设计 | 数据库规范 | 匹配 | |------|----------|------------|------| | 用户 | MOD-001 | users 表 | ⬜ | | 订单 | MOD-002 | orders 表 | ⬜ | ### 3.3 字段校验对齐 对于每个实体,验证: - 必填/可选状态匹配 - 数据类型兼容 - 约束等效 - 默认值一致 --- ## 4. UI/UX 对齐 ### 4.1 组件覆盖 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | UI-001 | 模块设计中的所有 UI 组件存在于 UI 规范中 | ⬜ | | | UI-002 | 设计令牌使用一致 | ⬜ | | | UI-003 | 无障碍要求已满足 | ⬜ | | | UI-004 | 响应式要求已处理 | ⬜ | | ### 4.2 屏幕/组件矩阵 | 屏幕 | 模块 | UI 规范引用 | 无障碍 | |------|------|-------------|--------| | 登录 | MOD-AUTH | 表单部分 | ⬜ | | 仪表盘 | MOD-001 | 仪表盘布局 | ⬜ | --- ## 5. 架构对齐 ### 5.1 组件一致性 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | ARCH-001 | 模块组件与架构规范匹配 | ⬜ | | | ARCH-002 | 集成模式一致 | ⬜ | | | ARCH-003 | 安全架构已实现 | ⬜ | | | ARCH-004 | 性能目标可实现 | ⬜ | | ### 5.2 技术栈验证 | 层级 | 架构规范 | 模块实现 | 匹配 | |------|----------|----------|------| | 前端 | | | ⬜ | | 后端 | | | ⬜ | | 数据库 | | | ⬜ | --- ## 6. 安全对齐 ### 6.1 安全需求覆盖 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | SEC-001 | 认证方法在文档间匹配 | ⬜ | | | SEC-002 | 授权规则一致 | ⬜ | | | SEC-003 | 数据保护需求已实现 | ⬜ | | | SEC-004 | 审计日志已指定 | ⬜ | | ### 6.2 权限矩阵对齐 | 角色 | 需求规范 | 模块设计 | 后端规范 | |------|----------|----------|----------| | 管理员 | | | ⬜ | | 用户 | | | ⬜ | --- ## 7. 性能对齐 ### 7.1 性能需求覆盖 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | PERF-001 | 响应时间目标已处理 | ⬜ | | | PERF-002 | 缓存策略已实现 | ⬜ | | | PERF-003 | 数据库索引支持查询模式 | ⬜ | | | PERF-004 | 限流已配置 | ⬜ | | ### 7.2 性能目标矩阵 | 需求 | 架构 | 后端 | 数据库 | |------|------|------|--------| | < 500ms P95 | ⬜ | ⬜ | ⬜ | | 100 请求/秒 | ⬜ | ⬜ | ⬜ | --- ## 8. 命名一致性 ### 8.1 术语检查 | 检查编号 | 描述 | 状态 | 详情 | |----------|------|------|------| | NAME-001 | 实体名称一致 | ⬜ | | | NAME-002 | API 端点命名遵循约定 | ⬜ | | | NAME-003 | 变量/字段命名一致 | ⬜ | | | NAME-004 | 状态值一致 | ⬜ | | ### 8.2 术语表 | 术语 | 需求 | 模块 | 数据库 | API | |------|------|------|--------|-----| | 用户 | | | users | /users | | 订单 | | | orders | /orders | --- ## 9. 文档完整性 ### 9.1 必需章节检查 | 文档 | 必需章节 | 完整 | |------|----------|------| | requirements-spec.md | 执行摘要、功能需求、非功能需求、约束 | ⬜ | | module-planning.md | 模块列表、依赖、顺序 | ⬜ | | module-design.md(每个) | API、数据模型、业务逻辑 | ⬜ | | architecture-spec.md | 技术栈、组件、部署 | ⬜ | | ui-ux-spec.md | 颜色、排版、组件 | ⬜ | | backend-spec.md | API 标准、认证、校验 | ⬜ | | database-spec.md | 表、索引、约束 | ⬜ | --- ## 10. 人工审查点 ### 10.1 业务逻辑一致性 - [ ] 业务规则在模块间一致 - [ ] 边界情况处理一致 - [ ] 状态转换有效 - [ ] 错误处理全面 ### 10.2 用户体验流程 - [ ] 用户旅程完整 - [ ] 错误状态已设计 - [ ] 成功状态已定义 - [ ] 边界情况 UI 已指定 ### 10.3 集成点 - [ ] 外部集成已文档化 - [ ] 数据格式兼容 - [ ] 集成错误处理 - [ ] 重试/降级策略已定义 --- ## 校验报告模板 ```markdown # 一致性校验报告 **项目:** {项目名称} **日期:** {日期} **校验者:** Claude(半自动) ## 摘要 | 类别 | 检查数 | 通过 | 警告 | 失败 | |------|--------|------|------|------| | 需求 | 4 | | | | | API | 4 | | | | | 数据模型 | 4 | | | | | UI/UX | 4 | | | | | 架构 | 4 | | | | | 安全 | 4 | | | | | 性能 | 4 | | | | | 命名 | 4 | | | | | **总计** | **32** | | | | ## 详细结果 ### 严重问题(必须修复) 1. [检查编号] 描述 - 位置:文件、章节 - 建议:修复操作 ### 警告(建议审查) 1. [检查编号] 描述 - 位置:文件、章节 - 建议:审查操作 ### 需要人工审查 1. [区域] 描述 - 原因:原因 - 建议审查者:角色 ## 建议 1. 优先级 1 建议 2. 优先级 2 建议 3. 优先级 3 建议 ``` --- ## 校验执行指南 ### 自动检查(可脚本化) 1. **需求覆盖**:解析 FR-* 编号,交叉引用模块 2. **API 端点矩阵**:从模块设计提取端点,比较后端规范 3. **实体对齐**:从模块设计解析实体,比较数据库规范 4. **命名一致性**:提取实体/字段名称,检查变体 ### 需要人工审查 1. 业务逻辑一致性 2. 用户体验流程完整性 3. 集成点兼容性 4. 安全实现细节 ### 执行校验 1. 生成所有规范文档 2. 运行自动检查 3. 审查自动检查结果 4. 对标记项进行人工审查 5. 生成一致性报告 6. 处理严重问题 7. 修复后重新校验