@chongyan/autospec 1.0.2 → 1.0.4

package/knowledge/04-checklists/01-design.md

@@ -1,196 +0,0 @@
-# 设计分析检查清单
-
-> **版本**: v2.0
-> **最后更新**: 2026-03-26
-> **基于**: 业界系统设计检查清单
-> **适用范围**: 所有系统设计场景
-
----
-
-## 必填章节检查
-
-以下章节为必填，缺少则设计文档不完整：
-
-- [ ] 1. 项目背景
-- [ ] 2. 业务用例
-- [ ] 3.1 功能点列表
-- [ ] 3.2 所有功能点的详细设计
-
----
-
-## 两步生成检查
-
-### Phase 1: 大纲生成
-
-- [ ] 项目背景填写完整（目标、参与人、相关文档）
-- [ ] 业务用例图从 proposal 正确提取
-- [ ] 功能点列表完整，覆盖 proposal 所有功能
-- [ ] 功能点命名清晰，职责单一
-- [ ] 功能点全部标记为 `- [ ]` 未完成
-- [ ] 详细设计章节占位符正确（`> ⏳ 待细化`）
-
-### Phase 2: 逐个细化
-
-- [ ] 所有功能点已标记为 `- [x]` 完成
-- [ ] 每个功能点都有详细设计内容
-- [ ] 详细设计包含概述、流程图、下游交互等
-- [ ] 流程图可正常渲染
-- [ ] 与 proposal.md 业务流程一致
-
----
-
-## 设计质量检查
-
-### 设计原则检查
-
-- [ ] 无实现代码平铺（方法设计只描述职责、入参、输出）
-- [ ] 功能点职责不重叠（无多个功能点重复描述同一逻辑）
-- [ ] 开关/配置无过度设计（能由调用方控制的不在本系统加开关）
-- [ ] 新增配置与项目已有配置声明方式一致
-
-### 领域模型检查
-
-- [ ] 领域模型图清晰展示实体关系
-- [ ] 状态机图正确描述状态流转
-- [ ] 数据库设计符合范式
-- [ ] 索引设计合理
-
-### 接口设计检查
-
-- [ ] 接口定义清晰（输入、输出、错误码）
-- [ ] 接口粒度适中（不过粗不过细）
-- [ ] 接口版本管理策略明确
-- [ ] 向后兼容性已考虑
-
----
-
-## 架构规范检查
-
-### 分层架构
-
-- [ ] 系统分层清晰（业务层、领域层、数据层）
-- [ ] 各层职责明确
-- [ ] 层间依赖合理（不跨层、不循环）
-
-### 模块划分
-
-- [ ] 模块职责单一
-- [ ] 模块间接口清晰
-- [ ] 模块可独立测试
-
-### 依赖管理
-
-- [ ] 依赖方向正确（依赖抽象不依赖具体）
-- [ ] 无循环依赖
-- [ ] 第三方依赖版本明确
-
----
-
-## 共享组件/依赖库检查（如涉及）
-
-- [ ] Maven 坐标明确（groupId:artifactId）
-- [ ] 当前版本明确
-- [ ] 升级版本明确
-- [ ] 变更内容详细说明
-- [ ] 需升级的系统列表明确
-
----
-
-## 非功能设计检查
-
-### 性能设计
-
-- [ ] 性能目标明确
-- [ ] 瓶颈分析到位
-- [ ] 优化措施具体
-
-### 安全设计
-
-- [ ] 认证方案明确
-- [ ] 授权方案明确
-- [ ] 数据保护方案明确
-
-### 可用性设计
-
-- [ ] SLA 目标明确
-- [ ] 降级策略具体
-- [ ] 容灾方案完备
-
----
-
-## 三板斧检查
-
-### 灰度策略
-
-- [ ] 灰度维度已定义
-- [ ] 灰度比例已明确
-- [ ] 灰度回滚方案已定义
-
-### 监控设计
-
-- [ ] 关键业务节点已识别
-- [ ] 监控指标已定义
-- [ ] 告警阈值已明确
-
-### 应急预案
-
-- [ ] 风险项已识别
-- [ ] 应急操作已定义
-- [ ] 操作步骤清晰
-
----
-
-## 关键假设检查
-
-- [ ] 关键假设清单已填写
-- [ ] 假设分为"已确认"和"待确认"
-- [ ] 待确认假设不超过 3 个
-- [ ] 需求阶段的关键假设已校验
-
----
-
-## 风险检查
-
-- [ ] 技术风险已识别
-- [ ] 业务风险已识别
-- [ ] 缓解措施已定义
-
----
-
-## 文档质量检查
-
-- [ ] 文档结构符合模板
-- [ ] 流程图可正常渲染
-- [ ] 链接全部有效
-- [ ] 无拼写错误和语法错误
-- [ ] 格式统一
-
----
-
-## 检查记录
-
-| 检查项 | 检查结果 | 检查人 | 检查日期 |
-|-------|---------|--------|---------|
-| 必填章节 | 通过/不通过 | | |
-| 两步生成 | 通过/不通过 | | |
-| 设计质量 | 通过/不通过 | | |
-| 架构规范 | 通过/不通过 | | |
-| 共享组件/依赖库 | 通过/不通过 | | |
-| 非功能设计 | 通过/不通过 | | |
-| 三板斧 | 通过/不通过 | | |
-| 关键假设 | 通过/不通过 | | |
-| 风险 | 通过/不通过 | | |
-| 文档质量 | 通过/不通过 | | |
-
-**总体结论**: 通过 / 不通过
-
-**备注**:
-{记录需要关注的问题}
-
----
-
-## 参考资料
-
-- [系统设计指南](../guides/system-design.md)
-- [design 模板](../templates/design.md)
-- [设计哲学 - 两步生成](../principles/01-first-principles.md#核心设计模式)

package/knowledge/04-checklists/02-code.md

@@ -1,197 +0,0 @@
-# 编码实现检查清单
-
-> **版本**: v2.0
-> **最后更新**: 2026-03-26
-> **基于**: 业界编码规范 + Code Review 规范
-> **适用范围**: 所有编码实现场景
-
----
-
-## Layer 1 验证检查
-
-### 编译检查
-
-- [ ] 代码编译通过
-- [ ] 无编译警告（或警告已评估可接受）
-- [ ] 编译日志已保存
-
-### 单元测试检查
-
-- [ ] 新增代码有对应单元测试
-- [ ] 现有测试全部通过
-- [ ] 测试覆盖率达标（本次变更行覆盖率 ≥ 工程整体覆盖率）
-- [ ] 测试日志已保存
-
-### Lint 检查
-
-- [ ] 代码风格符合规范
-- [ ] 无 lint 警告
-- [ ] Lint 报告已保存
-
-### 类型检查
-
-- [ ] 类型定义完整
-- [ ] 无类型错误
-- [ ] 类型检查报告已保存
-
----
-
-## 编码规范检查
-
-### 数据安全（一锁二判三更新）
-
-- [ ] 并发场景已加锁（锁定单点资源）
-- [ ] 基于最新状态判断（状态检查、金额检查）
-- [ ] 判断通过后再更新
-- [ ] 金额计算使用 Money 类（禁止 float/double）
-
-### 异常处理
-
-- [ ] 异步方法已捕获异常（@Async、线程池、Future）
-- [ ] 无空 catch 块
-- [ ] 异常日志包含完整堆栈
-- [ ] 异常级别准确（ERROR/WARN/INFO）
-
-### 多线程
-
-- [ ] ThreadLocal 使用完毕后调用 remove() 清理
-- [ ] 线程池为有界线程池（队列长度≤100）
-- [ ] 无全局变量/static 变量滥用
-- [ ] 共享对象有锁保护
-
-### 数据库
-
-- [ ] 无 SELECT * 查询
-- [ ] 使用参数化查询（#{}，禁止 ${}）
-- [ ] SQL 带 where 条件
-- [ ] 查询走索引
-
-### 日志规范
-
-- [ ] 使用 LogUtil 打印日志（带 TraceId）
-- [ ] 使用{0}{1}占位符（不字符串拼接）
-- [ ] 关键业务节点有日志
-- [ ] 异常日志包含异常对象
-
-### AOP 原则检查（跨切面功能）
-
-- [ ] **日志打印**：使用 LogUtil 而非直接 Logger（自动带 TraceId）
-- [ ] **监控埋点**：关键业务节点有 [MONITOR] 日志标记
-- [ ] **鉴权拦截**：权限校验通过切面实现，不侵入业务代码
-- [ ] **事务管理**：事务通过 @Transactional 注解实现
-- [ ] **异常处理**：全局异常处理器统一处理
-- [ ] **TraceId 传递**：入口方法有 TraceId 传递（Controller 层）
-
-### 埋点规范检查
-
-- [ ] 入口方法有 TraceId 传递
-- [ ] 关键业务状态变更有监控埋点
-- [ ] 外部调用有耗时统计埋点
-
----
-
-## 代码质量检查
-
-### 可读性
-
-- [ ] 命名清晰表达用途
-- [ ] 注释解释"为什么"而非"是什么"
-- [ ] 代码风格与团队一致
-- [ ] 函数长度合理（<50 行）
-- [ ] 嵌套层次不超过 2 层
-- [ ] if 分支不超过 5 个
-
-### 可靠性
-
-- [ ] 有水平权限校验
-- [ ] 后端接口校验入参
-- [ ] 对象比较使用 equals
-- [ ] 有超时时间设置
-- [ ] 资源正确释放
-
-### 可扩展性
-
-- [ ] 功能可继续扩展
-- [ ] 无并发瓶颈
-- [ ] 锁粒度合理
-
----
-
-## 功能实现检查
-
-- [ ] 需求完整实现（对照 design.md）
-- [ ] 边界情况已处理
-- [ ] 异常情况已处理
-- [ ] 向后兼容
-
----
-
-## 三板斧检查
-
-### 灰度
-
-- [ ] 功能开关已添加
-- [ ] 灰度配置已添加（DRM 等）
-- [ ] 降级方案已实现
-
-### 监控
-
-- [ ] 关键业务节点有日志
-- [ ] 监控指标已埋点
-- [ ] 异常告警已配置
-
-### 应急
-
-- [ ] 应急操作手册已编写
-- [ ] 回滚方案已验证
-- [ ] 负责人已明确
-
----
-
-## 自测检查
-
-### 正向场景
-
-- [ ] 主流程自测通过
-- [ ] 正常输入输出符合预期
-
-### 异常场景
-
-- [ ] 异常输入处理正确
-- [ ] 错误提示友好
-
-### 边界场景
-
-- [ ] 边界值处理正确
-- [ ] 极限情况处理正确
-
-### 幂等场景
-
-- [ ] 重复调用处理正确
-- [ ] 状态机推进正确
-
----
-
-## 检查记录
-
-| 检查项 | 检查结果 | 检查人 | 检查日期 |
-|-------|---------|--------|---------|
-| Layer 1 验证 | 通过/不通过 | | |
-| 编码规范 | 通过/不通过 | | |
-| 代码质量 | 通过/不通过 | | |
-| 功能实现 | 通过/不通过 | | |
-| 三板斧 | 通过/不通过 | | |
-| 自测 | 通过/不通过 | | |
-
-**总体结论**: 通过 / 不通过
-
-**备注**:
-{记录需要关注的问题}
-
----
-
-## 参考资料
-
-- [编码规范](../standards/coding-style.md)
-- [Code Review 规范](../standards/code-review.md)
-- [设计哲学 - 双层验证](../principles/01-first-principles.md#dp1-双层验证)

package/knowledge/04-checklists/03-test.md

@@ -1,46 +0,0 @@
-# 测试设计检查清单
-
-> 供 test-generator skill 和 test-reviewer skill 引用，确保测试覆盖完整。
-
-## 边界条件测试（必须覆盖）
-
-- [ ] 空值测试：null、undefined、空字符串、空数组
-- [ ] 边界值测试：0、-1、最大值、最小值、临界值
-- [ ] 特殊字符测试：`< > & " ' / \`、emoji、多字节字符
-- [ ] 超长输入测试：超过最大长度限制的输入
-- [ ] 类型错误测试：传入错误类型参数
-
-## 异常路径测试（必须覆盖）
-
-- [ ] 网络异常：超时、连接失败、DNS解析失败
-- [ ] 资源异常：磁盘满、内存不足、文件不存在
-- [ ] 并发测试：多线程/多进程同时操作同一资源
-- [ ] 状态异常：未初始化、已关闭、事务冲突
-
-## 功能覆盖测试
-
-- [ ] 正向流程：正常输入，正常输出
-- [ ] 分支覆盖：每个if/else分支都有测试
-- [ ] 边界值覆盖：临界值前后都有测试
-- [ ] 前后置条件：依赖服务不可用时的行为
-
-## 安全测试（必须覆盖）
-
-- [ ] SQL注入：包含 `' -- ;` 等SQL关键字的输入
-- [ ] XSS攻击：包含 `<script>alert(1)</script>` 等HTML/JS的输入
-- [ ] 命令注入：包含 `; rm -rf` 等系统命令的输入
-- [ ] 越权访问：尝试访问未授权资源
-
-## 性能测试（建议覆盖）
-
-- [ ] 响应时间：核心接口响应时间在要求范围内
-- [ ] 并发能力：高并发下系统是否稳定
-- [ ] 资源占用：内存、CPU、磁盘IO是否可控
-
-## 测试质量标准
-
-- [ ] 测试可重复执行（无随机因素）
-- [ ] 测试之间无依赖（可并行执行）
-- [ ] 断言明确（失败信息清晰指出问题）
-- [ ] 测试数据可准备（不依赖外部不稳定状态）
-- [ ] 覆盖率达标：核心逻辑 > 70%，安全相关 > 90%

package/knowledge/04-checklists/04-release.md

@@ -1,70 +0,0 @@
-# 发布准备检查清单
-
-> 供 knowledge/02-process/06-delivery.md 质量关卡和 skills/delivery-stage 引用。
-
-## 必须检查
-
-### 基础检查
-
-- [ ] QA测试报告结论为通过
-- [ ] 无未解决的Critical/Major级别缺陷
-- [ ] 回滚方案已准备并验证可行
-- [ ] 变更记录已编写（含功能/修复列表、影响范围）
-- [ ] 数据库变更（如有）已review并有回滚脚本
-- [ ] 配置变更（如有）已确认
-- [ ] 应急开关/降级方案已准备（限流、降级、熔断）
-- [ ] 关键业务指标监控已配置（不仅技术指标，也含业务指标）
-- [ ] 资损点已识别并有针对性保障措施
-
-### 增强检查项
-
-- [ ] **风险检测项已执行**：风险登记表中的检测计划已全部执行
-- [ ] **业务规则已验证**：critical级别业务规则已通过端到端验证
-- [ ] **灰度策略已确定**：灰度比例/时间窗口/观察指标已明确
-
-## 建议检查
-
-### 基础建议
-
-- [ ] 相关方已通知（产品、运营、客服等）
-- [ ] 监控告警已配置或确认
-- [ ] 灰度/分批发布策略已确定（如适用）
-- [ ] 遗留风险已记录并经人工确认可接受
-- [ ] 发布时间窗口合适（避开高峰期）
-- [ ] 容量评估已完成（压测数据支撑机器数量决策）
-- [ ] 变更回滚预案已演练验证
-- [ ] 数据变更（如有）已通知下游使用方
-- [ ] 发布遵循最小价值单元策略（先样板间再横向扩展）
-
-### 增强建议项
-
-- [ ] **监控告警已演练**：模拟故障场景验证告警触发
-- [ ] **回滚演练已完成**：回滚脚本在测试环境已执行验证
-- [ ] **关键业务流程已验证**：业务流程图中标记的关键路径已通过
-- [ ] **术语已统一**：发布文档中的术语与 glossary.md 一致
-- [ ] **文档版本已更新**：涉及文档已更新版本号和更新说明
-
-## 发布后验证清单
-
-- [ ] 冒烟测试：核心功能是否正常
-- [ ] 监控指标：是否有异常波动（与基线对比）
-- [ ] 业务指标：关键业务指标是否正常
-- [ ] 告警检查：是否有新触发告警
-- [ ] 回滚验证：确认回滚路径畅通
-
-## 发布检查承诺书
-
-```markdown
-## 发布承诺
-
-| 检查项 | 状态 | 确认人 | 确认时间 |
-|--------|------|--------|---------|
-| 测试报告已通过 | ✅/❌ | | |
-| 风险检测已完成 | ✅/❌ | | |
-| 回滚方案已验证 | ✅/❌ | | |
-| 监控告警已配置 | ✅/❌ | | |
-| 变更记录已完备 | ✅/❌ | | |
-
-发布负责人签名：__________
-日期：__________
-```

package/knowledge/04-checklists/README.en.md

@@ -1,119 +0,0 @@
-# Checklists
-
-> **Purpose**: Self-check lists before each stage completion, ensuring quality gates
->
-> **Evolution Zone**: 🟡 Controlled (Auto-proposed + Human-approved)
-
----
-
-## Directory Structure
-
-```
-04-checklists/
-├── README.md                     # This file (Checklists Navigation)
-├── 00-requirement.md             # Requirement Checklist
-├── 01-design.md                  # Design Checklist
-├── 02-code.md                    # Code Checklist
-├── 03-test.md                    # Testing Checklist
-└── 04-release.md                 # Release Checklist
-```
-
----
-
-## Checklist Description
-
-### 00-requirement.md — Requirement Checklist
-
-**Content**: Check items before Requirement Analysis stage completion
-
-**Core Chapters**:
-- Requirement Completeness Check
-- Acceptance Criteria Clarity
-- Dependency & Constraint Identification
-- Clarification Questions Marked
-
-**Location**: [00-requirement.md](00-requirement.md)
-
-### 01-design.md — Design Checklist
-
-**Content**: Check items before Solution Design stage completion
-
-**Core Chapters**:
-- Architecture Design Rationality
-- Data Model Design
-- API Design Completeness
-- Technology Selection Record
-- Risk Assessment
-
-**Location**: [01-design.md](01-design.md)
-
-### 02-code.md — Code Checklist
-
-**Content**: Check items before Implementation stage completion
-
-**Core Chapters**:
-- Layer 1 Validation (Build/Test/Lint/Type Check)
-- Data Safety (Lock-Check-Update)
-- Exception Handling
-- Multi-threading Safety
-- Database Operations
-- Logging Standards
-
-**Location**: [02-code.md](02-code.md)
-
-### 03-test.md — Testing Checklist
-
-**Content**: Check items before QA Testing stage completion
-
-**Core Chapters**:
-- Test Case Coverage
-- Integration Test Completeness
-- E2E Testing
-- Acceptance Testing
-- Performance Testing (if required)
-
-**Location**: [03-test.md](03-test.md)
-
-### 04-release.md — Release Checklist
-
-**Content**: Check items before Delivery stage completion
-
-**Core Chapters**:
-- Pre-release Check
-- Rollback Plan
-- Monitoring & Alerting
-- Documentation Completeness
-
-**Location**: [04-release.md](04-release.md)
-
----
-
-## Usage
-
-Each checklist is executed before completing the corresponding stage:
-
-```
-Stage Execution → Layer 1 Validation → Layer 2 Review → Checklist Self-Check → Stage Complete
-```
-
-**Checklist Embedding**:
-- Each stage's skill automatically loads the corresponding checklist
-- AI self-checks against the checklist during execution
-- Automatically supplements any missing items
-
----
-
-## Related Documents
-
-| Document | Description |
-|----------|-------------|
-| [../02-process/](../02-process/) | 6-Stage Process Definition |
-| [../07-standards/](../07-standards/) | Coding/Review Standards |
-| [../03-guides/](../03-guides/) | Stage Execution Skills |
-
----
-
-**Maintainer**: AutoSpec Team
-**Evolution Zone**: 🟡 Controlled
-**Version**: v1.0
-**Last Updated**: 2026-03-27