@zeyue0329/xiaoma-cli 1.0.20 → 1.0.22

package/xiaoma-core/checklists/dev-completion-checklist.md

@@ -0,0 +1,324 @@
+# 开发完成检查清单
+
+## 检查清单概述
+
+本检查清单用于开发者在完成用户故事实现后进行全面的自检验证，确保代码质量、功能完整性和测试覆盖度都达到要求标准。
+
+## 代码实现完整性检查
+
+### 数据库层实现
+
+- [ ] **Entity类**: 实体类字段映射正确，注解完整
+- [ ] **Mapper接口**: 所有必需的数据库操作方法已实现
+- [ ] **Mapper XML**: SQL语句正确，参数映射准确
+- [ ] **数据验证**: 数据校验注解和逻辑完整
+- [ ] **事务处理**: 事务边界和传播行为正确设置
+
+### 业务逻辑层实现
+
+- [ ] **Service接口**: 业务接口定义清晰完整
+- [ ] **Service实现**: 业务逻辑实现符合需求
+- [ ] **业务规则**: 所有业务规则都已实现
+- [ ] **异常处理**: 异常情况处理完善
+- [ ] **数据转换**: DTO和Entity转换逻辑正确
+
+### API接口层实现
+
+- [ ] **Controller方法**: 所有API端点都已实现
+- [ ] **参数验证**: 请求参数验证逻辑完整
+- [ ] **响应格式**: 响应数据格式符合API规范
+- [ ] **HTTP状态码**: 状态码使用正确
+- [ ] **错误处理**: 错误响应格式标准化
+
+### 配置和依赖
+
+- [ ] **依赖注入**: Spring Bean配置正确
+- [ ] **配置文件**: 必要的配置参数已添加
+- [ ] **数据库配置**: 数据源和连接池配置正确
+- [ ] **日志配置**: 日志级别和格式配置适当
+
+## 代码质量检查
+
+### 代码规范
+
+- [ ] **命名规范**: 类名、方法名、变量名符合Java规范
+- [ ] **代码格式**: 代码缩进、空行、注释格式统一
+- [ ] **注释完整**: 关键方法和复杂逻辑有充分注释
+- [ ] **导入优化**: 无多余的import语句
+- [ ] **Magic Number**: 避免硬编码数字，使用常量
+
+### 设计原则
+
+- [ ] **单一职责**: 每个类和方法职责单一清晰
+- [ ] **开闭原则**: 设计对扩展开放，对修改封闭
+- [ ] **依赖倒置**: 依赖抽象而不是具体实现
+- [ ] **接口隔离**: 接口定义简洁，职责分离
+- [ ] **DRY原则**: 避免重复代码，提取公共方法
+
+### 性能考虑
+
+- [ ] **SQL优化**: 数据库查询语句优化，避免N+1问题
+- [ ] **缓存使用**: 适当使用缓存提升性能
+- [ ] **资源管理**: 正确关闭资源，避免内存泄漏
+- [ ] **算法复杂度**: 算法时间和空间复杂度合理
+- [ ] **批量操作**: 批量数据操作使用批处理
+
+## 功能实现验证
+
+### 核心功能验证
+
+- [ ] **主要流程**: 核心业务流程功能正常
+- [ ] **数据CRUD**: 增删改查操作都正确实现
+- [ ] **业务规则**: 所有业务规则验证生效
+- [ ] **数据关联**: 相关数据的关联和级联操作正确
+- [ ] **状态管理**: 数据状态转换逻辑正确
+
+### 边界条件处理
+
+- [ ] **空值处理**: null值和空字符串处理适当
+- [ ] **边界值**: 最大值、最小值、临界值处理正确
+- [ ] **数据长度**: 字符串长度限制验证有效
+- [ ] **数值范围**: 数值范围校验生效
+- [ ] **并发处理**: 并发访问情况下数据一致性保证
+
+### 异常情况处理
+
+- [ ] **参数异常**: 无效参数抛出适当异常
+- [ ] **业务异常**: 业务逻辑异常处理完善
+- [ ] **系统异常**: 系统级异常有合理降级处理
+- [ ] **网络异常**: 网络超时和连接异常处理
+- [ ] **数据库异常**: 数据库连接和操作异常处理
+
+## 测试代码完整性
+
+### 单元测试
+
+- [ ] **测试覆盖率**: 代码覆盖率达到80%以上
+- [ ] **Service测试**: 业务逻辑层单元测试完整
+- [ ] **Mapper测试**: 数据访问层测试充分
+- [ ] **Controller测试**: API接口单元测试完整
+- [ ] **工具类测试**: 工具类和辅助方法测试完整
+
+### 集成测试
+
+- [ ] **数据库集成**: 数据库操作集成测试
+- [ ] **API集成**: API接口集成测试
+- [ ] **服务集成**: 多个服务间集成测试
+- [ ] **外部依赖**: 外部服务调用集成测试
+- [ ] **端到端测试**: 完整业务流程端到端测试
+
+### 测试质量
+
+- [ ] **测试数据**: 测试用例使用多样化测试数据
+- [ ] **断言充分**: 测试断言覆盖所有重要输出
+- [ ] **独立性**: 测试用例之间相互独立
+- [ ] **可重复性**: 测试结果稳定可重复
+- [ ] **清理机制**: 测试后数据清理机制完善
+
+## API规范符合性
+
+### 请求处理
+
+- [ ] **HTTP方法**: 使用正确的HTTP方法(GET/POST/PUT/DELETE)
+- [ ] **URL设计**: URL路径设计符合RESTful规范
+- [ ] **参数绑定**: 请求参数正确绑定到方法参数
+- [ ] **Content-Type**: 正确处理不同的Content-Type
+- [ ] **请求头处理**: 必要的请求头信息正确处理
+
+### 响应处理
+
+- [ ] **统一格式**: 响应格式符合项目统一标准
+- [ ] **状态码**: HTTP状态码使用准确
+- [ ] **错误响应**: 错误响应格式标准化
+- [ ] **分页处理**: 分页查询响应格式正确
+- [ ] **响应头**: 必要的响应头信息完整
+
+### 文档一致性
+
+- [ ] **Swagger注解**: API文档注解完整准确
+- [ ] **参数说明**: 请求参数说明详细
+- [ ] **响应说明**: 响应数据结构说明清晰
+- [ ] **示例数据**: 请求响应示例准确
+- [ ] **错误码说明**: 错误码含义说明完整
+
+## 数据库设计符合性
+
+### 数据模型
+
+- [ ] **表结构**: 实际表结构与设计文档一致
+- [ ] **字段类型**: 数据库字段类型使用正确
+- [ ] **约束条件**: 主键、外键、唯一约束正确设置
+- [ ] **索引设计**: 查询索引设计合理有效
+- [ ] **默认值**: 字段默认值设置合理
+
+### 数据操作
+
+- [ ] **CRUD完整**: 增删改查操作完整实现
+- [ ] **事务一致性**: 事务边界设置保证数据一致性
+- [ ] **软删除**: 删除操作使用软删除机制
+- [ ] **乐观锁**: 并发更新使用乐观锁机制
+- [ ] **审计字段**: 创建时间、更新时间等审计字段维护
+
+### 性能优化
+
+- [ ] **查询优化**: SQL查询语句性能优化
+- [ ] **批量处理**: 批量数据操作使用批处理
+- [ ] **连接查询**: 避免过多的连接查询
+- [ ] **分页查询**: 大数据量查询使用分页
+- [ ] **缓存策略**: 适当使用查询缓存
+
+## 安全性检查
+
+### 输入验证
+
+- [ ] **参数校验**: 所有输入参数都有适当校验
+- [ ] **SQL注入**: 使用参数化查询防止SQL注入
+- [ ] **XSS防护**: 输入数据转义防止XSS攻击
+- [ ] **文件上传**: 文件上传安全验证
+- [ ] **权限验证**: API接口权限验证生效
+
+### 数据安全
+
+- [ ] **敏感数据**: 敏感数据加密存储
+- [ ] **日志安全**: 日志中不包含敏感信息
+- [ ] **错误信息**: 错误信息不暴露敏感内容
+- [ ] **访问控制**: 数据访问权限控制适当
+- [ ] **数据脱敏**: 查询结果适当脱敏
+
+## 测试执行结果
+
+### 自动化测试
+
+- [ ] **单元测试**: 所有单元测试通过 ✅
+- [ ] **集成测试**: 集成测试全部通过 ✅
+- [ ] **API测试**: API接口测试全部通过 ✅
+- [ ] **覆盖率测试**: 代码覆盖率达到要求 ✅
+- [ ] **静态分析**: 静态代码分析通过 ✅
+
+### 功能测试
+
+- [ ] **正常流程**: 正常业务流程测试通过
+- [ ] **异常流程**: 异常处理流程测试通过
+- [ ] **边界测试**: 边界条件测试通过
+- [ ] **性能测试**: 性能基准测试通过
+- [ ] **压力测试**: 并发压力测试通过
+
+### 测试报告
+
+- [ ] **测试结果**: 测试结果详细记录
+- [ ] **覆盖报告**: 代码覆盖率报告生成
+- [ ] **性能数据**: 性能测试数据收集
+- [ ] **问题记录**: 发现的问题全部记录
+- [ ] **修复验证**: 修复后的验证结果
+
+## 文档和注释
+
+### 代码文档
+
+- [ ] **类注释**: 所有类都有详细的javadoc注释
+- [ ] **方法注释**: 公共方法都有参数和返回值说明
+- [ ] **复杂逻辑**: 复杂业务逻辑有充分的行内注释
+- [ ] **TODO清理**: 临时TODO注释已清理或转为任务
+- [ ] **版权信息**: 新增文件包含版权和作者信息
+
+### API文档
+
+- [ ] **Swagger更新**: Swagger文档与实现保持一致
+- [ ] **示例更新**: API调用示例更新到最新
+- [ ] **错误码更新**: 错误码文档更新完整
+- [ ] **变更记录**: API变更记录在changelog中
+- [ ] **版本标识**: API版本标识正确
+
+### 实现说明
+
+- [ ] **设计思路**: 复杂功能有设计思路说明
+- [ ] **技术选择**: 技术选择理由记录
+- [ ] **已知限制**: 当前实现的限制条件说明
+- [ ] **扩展建议**: 未来扩展建议记录
+- [ ] **依赖说明**: 外部依赖使用说明
+
+## 版本控制和部署
+
+### 代码提交
+
+- [ ] **提交信息**: 提交信息清晰描述变更内容
+- [ ] **分支策略**: 遵循项目分支管理策略
+- [ ] **冲突解决**: 代码合并冲突已正确解决
+- [ ] **文件清理**: 无临时文件和调试代码提交
+- [ ] **版本标识**: 相关文件版本号正确更新
+
+### 构建验证
+
+- [ ] **编译通过**: 代码编译无错误无警告
+- [ ] **依赖检查**: 项目依赖完整无冲突
+- [ ] **打包验证**: 应用打包成功
+- [ ] **启动验证**: 应用启动无错误
+- [ ] **功能验证**: 部署后功能验证通过
+
+## 完成标准确认
+
+### 功能完成度
+
+- [ ] **需求实现**: 用户故事所有需求都已实现
+- [ ] **验收标准**: 所有验收标准都能通过验证
+- [ ] **API规范**: API实现完全符合设计规范
+- [ ] **数据库**: 数据库操作符合设计要求
+- [ ] **错误处理**: 异常和错误处理完善
+
+### 质量标准
+
+- [ ] **代码质量**: 代码质量达到项目标准
+- [ ] **测试质量**: 测试覆盖率和质量达标
+- [ ] **性能标准**: 性能指标满足要求
+- [ ] **安全标准**: 安全检查全部通过
+- [ ] **文档标准**: 文档完整性达到要求
+
+### 交付就绪
+
+- [ ] **功能验证**: 开发者自测全部通过
+- [ ] **代码审查**: 代码自审查完成
+- [ ] **文档更新**: 相关文档都已更新
+- [ ] **部署验证**: 测试环境部署验证通过
+- [ ] **移交准备**: 准备好移交给QA团队
+
+## 问题记录和处理
+
+### 问题分类
+
+- [ ] **功能问题**: 功能实现不符合需求
+- [ ] **性能问题**: 性能不满足要求
+- [ ] **质量问题**: 代码质量不达标
+- [ ] **安全问题**: 安全漏洞或风险
+- [ ] **兼容问题**: 兼容性问题
+
+### 问题处理
+
+- [ ] **问题分析**: 详细分析问题原因
+- [ ] **解决方案**: 制定具体解决方案
+- [ ] **修复实施**: 按方案进行问题修复
+- [ ] **验证测试**: 修复后重新测试验证
+- [ ] **影响评估**: 评估修复对其他功能的影响
+
+## 使用说明
+
+### 检查流程
+
+1. 完成功能开发后，逐项检查本清单
+2. 对于每个检查项，标记通过(✅)或需要修复(❌)
+3. 记录发现的问题和修复方案
+4. 修复问题后重新检查相关项目
+5. 所有检查项通过后，更新故事状态为"Review"
+
+### 自检技巧
+
+- 站在用户角度验证功能完整性
+- 从代码质量角度审查实现质量
+- 从测试角度验证功能正确性
+- 从运维角度考虑部署和维护
+
+### 常见问题
+
+- **测试覆盖率不足**: 补充缺失的测试用例
+- **API文档不一致**: 更新Swagger注解和文档
+- **异常处理不完善**: 添加适当的异常处理逻辑
+- **性能问题**: 优化查询语句和算法实现

package/xiaoma-core/checklists/po-story-validation-checklist.md

@@ -0,0 +1,219 @@
+# PO故事验证检查清单
+
+## 检查清单概述
+
+本检查清单用于Product Owner验证用户故事的质量和完整性，确保故事符合业务需求并可以被开发团队正确实施。
+
+## 必填信息检查
+
+### 基础信息完整性
+
+- [ ] **用户故事**: 包含角色、行动、收益的完整描述
+- [ ] **验收标准**: 明确、可测试的验收条件
+- [ ] **优先级**: 业务优先级明确标注
+- [ ] **估算**: 开发工作量估算合理
+
+### 数据库设计相关
+
+- [ ] **相关实体**: 涉及的数据库实体全部识别
+- [ ] **数据操作**: CRUD操作类型明确定义
+- [ ] **业务规则**: 数据验证和业务约束清晰
+- [ ] **实体关系**: 与其他实体的关联关系准确
+
+### API接口规范
+
+- [ ] **端点定义**: API端点路径和HTTP方法正确
+- [ ] **请求参数**: 输入参数格式和验证规则完整
+- [ ] **响应格式**: 输出数据结构和格式明确
+- [ ] **错误处理**: 错误码和错误信息定义充分
+
+## 业务需求验证
+
+### PRD对齐检查
+
+- [ ] **需求匹配**: 故事内容与PRD需求完全对应
+- [ ] **功能边界**: 功能范围定义清晰，不超出边界
+- [ ] **业务价值**: 能够清晰表达对用户的价值
+- [ ] **用户角色**: 目标用户角色定义准确
+
+### 业务逻辑验证
+
+- [ ] **流程正确**: 业务流程逻辑正确无误
+- [ ] **规则完整**: 业务规则和约束考虑周全
+- [ ] **异常处理**: 异常和边界情况处理适当
+- [ ] **数据一致性**: 保证数据的一致性和完整性
+
+### 用户体验验证
+
+- [ ] **易用性**: 功能设计符合用户习惯
+- [ ] **可访问性**: 考虑不同用户群体的需求
+- [ ] **响应性能**: 性能要求符合用户期望
+- [ ] **错误提示**: 错误信息用户友好
+
+## 技术实现可行性
+
+### 架构兼容性
+
+- [ ] **系统架构**: 与现有系统架构兼容
+- [ ] **技术栈**: 使用的技术栈合适
+- [ ] **依赖关系**: 外部依赖关系明确
+- [ ] **扩展性**: 设计具备良好的扩展性
+
+### 数据库设计合理性
+
+- [ ] **表结构**: 数据库表结构设计合理
+- [ ] **索引策略**: 查询索引策略适当
+- [ ] **性能考虑**: 数据库操作性能可接受
+- [ ] **数据迁移**: 数据迁移方案可行
+
+### API设计规范性
+
+- [ ] **RESTful规范**: 遵循RESTful设计原则
+- [ ] **版本控制**: API版本控制策略明确
+- [ ] **安全性**: API安全认证和授权完备
+- [ ] **文档完整**: API文档详细准确
+
+## 可测试性验证
+
+### 验收标准质量
+
+- [ ] **明确性**: 验收标准表述清晰无歧义
+- [ ] **可验证**: 每个标准都可以通过测试验证
+- [ ] **完整性**: 覆盖所有主要功能点
+- [ ] **独立性**: 各个标准相互独立可单独测试
+
+### 测试场景覆盖
+
+- [ ] **正常流程**: 正常业务流程测试场景
+- [ ] **边界条件**: 边界值和临界条件测试
+- [ ] **异常情况**: 异常和错误情况处理测试
+- [ ] **性能测试**: 性能和负载测试场景
+
+### 测试数据准备
+
+- [ ] **测试数据**: 测试所需数据清晰定义
+- [ ] **数据依赖**: 数据依赖关系明确
+- [ ] **数据清理**: 测试后数据清理方案
+- [ ] **数据隐私**: 敏感数据处理符合规范
+
+## 依赖关系和风险评估
+
+### 依赖关系检查
+
+- [ ] **前置条件**: 开发前置条件全部满足
+- [ ] **依赖故事**: 依赖的其他故事状态确认
+- [ ] **外部依赖**: 外部系统和服务依赖明确
+- [ ] **资源依赖**: 所需资源和权限确认
+
+### 风险识别
+
+- [ ] **技术风险**: 技术实现风险评估
+- [ ] **业务风险**: 业务逻辑变更风险
+- [ ] **时间风险**: 开发时间估算风险
+- [ ] **质量风险**: 质量保证相关风险
+
+### 影响分析
+
+- [ ] **系统影响**: 对现有系统的影响分析
+- [ ] **数据影响**: 对现有数据的影响评估
+- [ ] **用户影响**: 对最终用户的影响评估
+- [ ] **运维影响**: 对系统运维的影响分析
+
+## 规模和复杂度评估
+
+### 故事规模检查
+
+- [ ] **适当规模**: 故事规模适合一个迭代完成
+- [ ] **原子性**: 故事不可再进一步合理拆分
+- [ ] **独立性**: 故事可以独立开发和测试
+- [ ] **价值完整**: 交付后能产生完整的业务价值
+
+### 复杂度评估
+
+- [ ] **技术复杂度**: 技术实现复杂度适中
+- [ ] **业务复杂度**: 业务逻辑复杂度可控
+- [ ] **集成复杂度**: 系统集成复杂度合理
+- [ ] **测试复杂度**: 测试验证复杂度适当
+
+## 质量标准检查
+
+### 文档质量
+
+- [ ] **语言表达**: 表述清晰准确无歧义
+- [ ] **结构完整**: 文档结构符合模板要求
+- [ ] **格式规范**: 格式和样式符合标准
+- [ ] **版本控制**: 版本信息和变更记录完整
+
+### 一致性检查
+
+- [ ] **内部一致**: 故事内部信息一致
+- [ ] **外部一致**: 与PRD和架构文档一致
+- [ ] **命名一致**: 术语和命名规范统一
+- [ ] **格式一致**: 与其他故事格式一致
+
+## 验证结果记录
+
+### 通过标准
+
+**当所有检查项都通过时**:
+
+- [ ] 更新故事状态: `Draft → Approved`
+- [ ] 记录验证通过时间: `{当前时间}`
+- [ ] 添加验证人员信息: `{PO姓名}`
+- [ ] 通知开发团队可以开始开发
+
+### 问题记录
+
+**当检查发现问题时**:
+
+- [ ] 详细记录具体问题描述
+- [ ] 标注问题的严重程度
+- [ ] 提供修复建议和指导
+- [ ] 设置重新验证的时间点
+
+### 修复跟踪
+
+- [ ] 问题修复后重新验证
+- [ ] 记录修复过程和结果
+- [ ] 确认所有问题都已解决
+- [ ] 验证修复没有引入新问题
+
+## 升级机制
+
+### 问题升级触发条件
+
+- [ ] 连续3次验证失败
+- [ ] 发现重大业务逻辑错误
+- [ ] 技术实现方案不可行
+- [ ] 涉及架构设计变更
+
+### 升级处理流程
+
+- [ ] 通知项目经理和产品经理
+- [ ] 组织相关方讨论解决方案
+- [ ] 必要时调整需求或设计
+- [ ] 重新评估故事优先级和计划
+
+## 使用说明
+
+### 验证流程
+
+1. 接收SM创建的用户故事(Draft状态)
+2. 逐项检查本清单的所有项目
+3. 记录检查结果和发现的问题
+4. 根据检查结果决定通过或修复
+5. 更新故事状态并通知相关方
+
+### 检查技巧
+
+- 站在最终用户的角度审视故事
+- 考虑功能的完整业务流程
+- 注意与其他功能的集成影响
+- 重点关注数据一致性和安全性
+
+### 常见问题
+
+- **验收标准不够具体**: 要求明确的可验证条件
+- **API设计不完整**: 确保包含完整的请求响应示例
+- **业务规则缺失**: 补充重要的业务逻辑约束
+- **依赖关系不明**: 明确前置条件和依赖的其他功能