@chongyan/autospec 1.0.1 → 1.0.2

package/knowledge/environment/template-registry.md

@@ -1,321 +0,0 @@
-# 环境知识模板注册表
-
-> 定义环境知识的模板类型、来源和输出位置。供 env-sync、env-import、env-validate 命令引用。
->
-> **版本**: v3.0
-> **最后更新**: 2026-03-26
-> **扩展说明**: 新增 design-knowledge/、test-knowledge/、business-knowledge/ 分类
-
----
-
-## 模板清单
-
-### 环境知识模板（原有）
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| middleware | middleware-knowledge.md | env-knowledge/middleware/{name}.md | 基本信息、环境变量、连接代码模板 |
-| component | component-knowledge.md | component-lib/components/{name}/component.md | 基本信息、接口定义、使用示例 |
-| infrastructure | middleware-knowledge.md | env-knowledge/infrastructure/{name}.md | 基本信息、环境变量 |
-
-### 研发流程模板
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| proposal | product-proposal.md | requirements/{业务域}/{需求}/proposal.md | 背景与价值、目标与范围、业务架构设计、用例业务流程 |
-| design | system-design.md | requirements/{业务域}/{需求}/{系统名}/design.md | 项目背景、业务用例、功能设计（大纲 + 详设）、领域模型 |
-| task | task-breakdown.md | requirements/{业务域}/{需求}/{系统名}/task.md | Meta 信息、Tasks 列表、Progress、Validation |
-| testcase | test-case.md | requirements/{业务域}/{需求}/{系统名}/testcase.md | 测试概要、测试用例、覆盖矩阵、覆盖统计 |
-
-### API 文档模板（新增）
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| api-overview | api-overview.md | docs/api/{服务名}/overview.md | 接口概述、认证方式、错误码 |
-| api-parameters | api-parameters.md | docs/api/{服务名}/parameters.md | 参数定义、类型说明、校验规则 |
-| api-error-codes | api-error-codes.md | docs/api/{服务名}/error-codes.md | 错误码列表、处理建议 |
-
-### 规范文档模板
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| coding-style | standards/coding-style.md | standards/coding-style.md | 数据安全、异常处理、多线程、数据库、日志规范 |
-| data-consistency | standards/data-consistency.md | standards/data-consistency.md | 一致性方案、幂等性设计、分布式事务 |
-| code-review | standards/code-review.md | standards/code-review.md | 评审原则、好代码三要素、检查清单 |
-
-### 设计知识模板
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| product-design | templates/product-proposal.md | design-knowledge/product/{name}.md | 背景与价值、目标与范围、业务架构设计 |
-| architecture | templates/system-design.md | design-knowledge/architecture/{name}.md | 项目背景、业务用例、功能设计、UML图 |
-| api-design | templates/api-design.md | design-knowledge/api/{name}.md | 接口概述、参数定义、错误码 |
-| database | templates/database-design.md | design-knowledge/database/{name}.md | ER图、表结构、索引设计 |
-
-### 测试知识模板
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| test-design | templates/test-case.md | test-knowledge/test-designs/{name}.md | 测试概要、测试用例、覆盖矩阵 |
-| evaluation | templates/ai-evaluation.md | test-knowledge/evaluation/{name}.md | 评测目标、数据集、指标、Badcase分析 |
-
-### 业务知识模板（新增）
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| glossary | domain/glossary.md | business-knowledge/glossary.md | 术语、定义、适用场景 |
-| business-rules | domain/rules.md | business-knowledge/rules.md | 规则ID、规则名称、规则描述、适用场景 |
-| business-flow | domain/flows/README.md | business-knowledge/flows/{name}-flow.md | 流程名称、Mermaid图、说明 |
-
-### DDD 模板（新增）
-
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| domain-driven-design | templates/domain-driven-design.md | design-knowledge/ddd/{name}-ddd.md | 领域识别、限界上下文、聚合设计 |
-
-**DDD模板适用场景**：
-- 复杂业务系统（业务概念 > 20个）
-- 核心业务建模
-- 微服务边界划分
-- 需要跨团队协作的项目
-
----
-
-## 模板分类
-
-| 分类 | 说明 | 模板列表 |
-|------|------|---------|
-| `environment/` | 环境知识模板 | middleware, component, infrastructure |
-| `design-knowledge/` | 设计知识模板 | product-design, architecture, api-design, database, domain-driven-design |
-| `test-knowledge/` | 测试知识模板 | test-design, evaluation |
-| `business-knowledge/` | 业务知识模板 | glossary, business-rules, business-flow |
-| `standards/` | 规范文档模板 | coding-style, data-consistency, code-review |
-| `ddd/` | DDD领域驱动设计模板 | domain-driven-design |
-
----
-
-## 类型枚举
-
-### 中间件类型
-
-| 类型 | 说明 | 典型示例 |
-|------|------|---------|
-| relational-database | 关系型数据库 | MySQL, PostgreSQL, Oracle |
-| document-database | 文档数据库 | MongoDB, CouchDB |
-| cache | 缓存 | Redis, Memcached |
-| message-queue | 消息队列 | Kafka, RabbitMQ, RocketMQ |
-| search-engine | 搜索引擎 | Elasticsearch, Solr |
-| vector-store | 向量存储 | Milvus, Pinecone, Weaviate |
-| object-storage | 对象存储 | OSS, S3, MinIO |
-
-### 组件类型
-
-| 类型 | 说明 | 典型示例 |
-|------|------|---------|
-| service-component | 服务组件，封装外部服务调用 | 认证组件、支付网关 |
-| utility | 工具组件，提供通用功能 | 日志组件、配置组件 |
-| library | 库组件，封装业务逻辑 | 领域模型、数据访问层 |
-
----
-
-## 必填章节定义
-
-### development 模板必填章节
-
-#### proposal 模板
-
-| 章节 | 说明 |
-|------|------|
-| 1. 背景与价值 | 业务背景、业务价值 |
-| 2. 目标与范围 | 目标 (Success Criteria)、范围 (包含/不包含) |
-| 3. 业务架构设计 | 总体架构图、需求用例图、用例业务流程 |
-
-#### design 模板
-
-| 章节 | 说明 |
-|------|------|
-| 1. 项目背景 | 目标、参与人、相关文档 |
-| 2. 业务用例 | Mermaid flowchart |
-| 3. 功能设计 | 功能点列表、详细设计（两步生成） |
-
-#### task 模板
-
-| 章节 | 说明 |
-|------|------|
-| Meta | design 路径、system 引用 |
-| Tasks | 任务列表（Goal/Depends/Files/Done when） |
-| Progress | 进度跟踪 |
-
-#### testcase 模板
-
-| 章节 | 说明 |
-|------|------|
-| 1. 测试概要 | 需求、系统、来源、用例统计 |
-| 3. 测试用例 | 正向/异常/边界/幂等/回归场景 |
-| 5. 覆盖统计 | 各优先级用例数量统计 |
-
-### middleware 模板必填章节
-
-| 章节 | 说明 |
-|------|------|
-| 基本信息 | 名称、类型、默认端口、知识版本 |
-| 环境变量 | 必需变量表格、可选变量表格 |
-| 连接代码模板 | Node.js、Python 等语言的连接代码 |
-
-### component 模板必填章节
-
-| 章节 | 说明 |
-|------|------|
-| 基本信息 | 名称、类型、版本、维护者 |
-| 接口定义 | 方法名、输入参数、输出参数、错误码 |
-| 使用示例 | 安装命令、代码示例 |
-
-### standards 模板必填章节
-
-#### coding-style 模板
-
-| 章节 | 说明 |
-|------|------|
-| 数据安全 | 一锁二判三更新、金额计算规范 |
-| 异常处理 | 异步方法异常捕获、禁止空 catch |
-| 多线程 | ThreadLocal 清理、线程池规范 |
-| 数据库 | 禁止 SELECT *、参数化查询 |
-| 日志规范 | LogUtil 使用、日志级别 |
-
-#### data-consistency 模板
-
-| 章节 | 说明 |
-|------|------|
-| 一致性方案 | 分布式事务、中间态 + 重试、消息队列 |
-| 幂等性设计 | 唯一索引、分布式锁、Token 机制、状态机 |
-| 分布式事务 | 2PC、SAGA 模式 |
-
-#### code-review 模板
-
-| 章节 | 说明 |
-|------|------|
-| 评审原则 | 24 小时响应、不苛求完美、正向激励 |
-| 好代码三要素 | 可读性、可靠性、可扩展性 |
-| 检查清单 | 可读性检查、可靠性检查、可扩展性检查 |
-
----
-
-## 同步策略
-
-### 环境知识同步（middleware/component）
-
-**首次同步**:
-1. 复制 `detection-patterns.yaml` 到本地
-2. 扫描依赖文件、代码模式、环境变量
-3. 按 MD 模板生成知识文件
-4. 校验必填章节完整性
-5. 注册到 registry.json
-
-**增量同步**:
-1. 扫描变更的依赖和代码
-2. 对比已有知识文件
-3. 仅更新变更项
-4. 校验后更新注册表
-
-### 研发模板同步（proposal/design/task/testcase）
-
-**模板加载**:
-1. 从 `knowledge/templates/` 读取模板文件
-2. 解析模板中的占位符（如 `{需求名称}`）
-3. 根据用户输入填充占位符
-4. 输出到目标位置
-
-**模板验证**:
-1. 检查必填章节是否存在
-2. 检查占位符是否全部填充
-3. 检查 Markdown 格式是否正确
-
-### 规范文档同步（standards）
-
-**规范加载**:
-1. 从 `knowledge/standards/` 读取规范文件
-2. 解析规范中的检查项
-3. 集成到 code-review 流程中
-
-**规范更新**:
-1. 定期 review 规范文档
-2. 根据实践反馈更新规范
-3. 更新后通知所有使用者
-
----
-
-## 校验规则
-
-### 章节完整性校验
-
-检查 MD 文件是否包含所有必填章节：
-
-```
-middleware:
-  - "## 基本信息"
-  - "## 环境变量"
-  - "## 连接代码模板"
-
-component:
-  - "## 基本信息"
-  - "## 接口定义"
-  - "## 使用示例"
-```
-
-### 表格格式校验
-
-- 表格必须有表头行
-- 表格列数必须一致
-- 必填表格不能为空
-
-### 类型枚举校验
-
-- 中间件类型必须在预定义枚举中
-- 组件类型必须在预定义枚举中
-
----
-
-## AI 生成参考
-
-### 环境知识生成
-
-| 场景 | 参考文件 |
-|------|---------|
-| 扫描检测 | `knowledge/guides/support/environment-scanner.md` |
-| 知识生成 | `knowledge/guides/support/knowledge-generator.md` |
-| 检测规则 | `knowledge/environment/detection-patterns.yaml` |
-
-### 研发文档生成
-
-| 场景 | 参考文件 |
-|------|---------|
-| 需求提案 | `knowledge/process/01-requirement.md` + `knowledge/templates/product-proposal.md` |
-| 系统设计 | `knowledge/process/02-design.md` + `knowledge/templates/system-design.md` |
-| 任务分解 | `knowledge/process/03-implementation.md` + `knowledge/templates/task-breakdown.md` |
-| 测试用例 | `knowledge/process/04-test.md` + `knowledge/templates/test-case.md` |
-| DDD设计 | `knowledge/guides/domain-driven-design.md` + `knowledge/templates/domain-driven-design.md` |
-
-### 规范文档引用
-
-| 场景 | 参考文件 |
-|------|---------|
-| 编码规范 | `knowledge/standards/coding-style.md` |
-| 数据一致性 | `knowledge/standards/data-consistency.md` |
-| Code Review | `knowledge/standards/code-review.md` |
-
----
-
-## 版本历史
-
-| 版本 | 日期 | 修改说明 |
-|-----|------|---------|
-| v1.0 | 2026-03-26 | 初始版本，定义 middleware 和 component 模板 |
-| v2.0 | 2026-03-26 | 新增 development/、api-docs/、standards/分类，注册所有研发模板和规范文档 |
-| v3.0 | 2026-03-26 | 新增 design-knowledge/、test-knowledge/、business-knowledge/ 分类，支持环境知识双向同步 |
-| v3.1 | 2026-03-26 | 新增 DDD 模板（domain-driven-design），模板命名规范化 |
-
----
-
-**维护者**: AutoSpec 团队
-**进化分区**: 🟡 受控区
-**关联文档**: `knowledge/environment/README.md`

package/knowledge/guides/requirement-engineering.md

@@ -1,329 +0,0 @@
-# 需求工程指南
-
-> **版本**: v1.0
-> **最后更新**: 2026-03-26
-> **基于**: 业界需求工程最佳实践 / 结构化需求分析方法
-> **适用范围**: 所有需求分析场景
-
----
-
-## 目标
-
-将原始需求转化为结构化、无歧义、可实现的需求文档（proposal.md）。
-
----
-
-## 8 类场景检查清单识别业务域
-
-在需求分析开始时，通过 8 类场景检查清单识别涉及的业务域：
-
-| 场景类型 | 检查问题 | 涉及业务域 |
-|---------|---------|-----------|
-| 外部对接 | 是否涉及外部系统、第三方服务对接？ | gateway（网关系统） |
-| 账户体系 | 是否涉及用户账户、资金账户、账务处理？ | account（账户系统） |
-| 交易链路 | 是否涉及下单、支付、确认、结算？ | trade（交易系统） |
-| 资产/资源管理 | 是否涉及资产计算、估值、登记？ | asset（资产/资源系统） |
-| 数据管道 | 是否涉及数据采集、清洗、流转、报表？ | data（数据系统） |
-| AI/模型 | 是否涉及模型训练、推理、效果评估？ | ai/ml（AI 系统） |
-| 运营营销 | 是否涉及活动、营销、用户运营？ | operation（运营系统） |
-| 监控运维 | 是否涉及监控、告警、应急、部署？ | ops（运维系统） |
-
-**使用方法**：
-1. 逐条检查 8 类场景
-2. 标记"涉及"的业务域
-3. 针对每个涉及的业务域，读取对应的领域知识（domain-xxx skill）
-4. 在需求文档中明确标注涉及的业务域
-
----
-
-## 需求提案 11 章节模板
-
-```markdown
-# Proposal: {需求名称}
-
-## 1. 背景与价值
-### 1.1 业务背景
-### 1.2 业务价值 (Why)
-
-## 2. 目标与范围
-### 2.1 目标 (Success Criteria)
-### 2.2 范围 (包含/不包含)
-
-## 3. 业务架构设计
-### 3.1 总体架构图
-### 3.2 需求用例图
-### 3.3 业务域拆解
-### 3.4 资金流方案 (涉及资金链路时必须)
-### 3.5 用例业务流程
-### 3.6 跨域接口 (概要)
-### 3.7 数据一致性保障
-
-## 4. 关键决策
-
-## 5. 风险与缓解
-
-## 6. 非目标与约束
-### 6.1 非目标
-### 6.2 知识库缺失识别
-
-## 7. Open Questions
-
-## 8. 参考资料
-```
-
-### 各章节编写指南
-
-#### 1. 背景与价值
-
-**1.1 业务背景**：
-- 描述当前面临的问题或机会
-- 用数据说话（当前指标、目标指标）
-- 避免主观描述，用客观事实
-
-**1.2 业务价值**：
-- 为什么要做这个需求
-- 预期的业务价值是什么
-- 与团队/公司目标的对齐关系
-
-#### 2. 目标与范围
-
-**2.1 目标 (Success Criteria)**：
-- 用 SMART 原则定义目标
-- 可衡量的指标（例如：支持 X 场景、性能提升 Y%）
-- 验收的具体标准
-
-**2.2 范围**：
-- **包含**：明确列出本次需求包含的功能
-- **不包含**：明确排除的范围，避免范围蔓延
-
-#### 3. 业务架构设计
-
-**3.1 总体架构图**：
-- 使用 Mermaid flowchart
-- 按功能域分层展示
-- 标注系统边界和外部交互
-
-**3.2 需求用例图**：
-- 使用 Mermaid flowchart
-- 按角色分组
-- 原子粒度用例（不可再拆分）
-
-**3.3 业务域拆解**：
-| 场景类型 | 是否涉及 | 业务域 | 识别依据 |
-|---------|---------|--------|---------|
-| 外部对接 | Y/N | gateway | ... |
-| ... | ... | ... | ... |
-
-**3.4 资金流方案**（涉及资金链路时必须）：
-- 使用 Mermaid flowchart 或 sequence diagram
-- 标注账户间资金流转
-- 标注时间和方向
-
-**3.5 用例业务流程**：
-- 每个用例一个 sequence diagram
-- 从用户视角描述交互流程
-- 标注异常处理分支
-
-**3.6 跨域接口**（概要）：
-| 接口名 | 调用方 | 被调用方 | 协议 | 说明 |
-|-------|--------|---------|------|------|
-
-**3.7 数据一致性保障**：
-- 描述数据一致性方案
-- 分布式事务（2PC/SAGA）
-- 中间态 + 定时任务重试
-- 消息队列（RocketMQ）
-
-#### 4. 关键决策
-
-| 决策点 | 选项 | 决策 | 理由 |
-|-------|------|------|------|
-| {决策 1} | 选项 A/B | {决策} | {理由} |
-
-#### 5. 风险与缓解
-
-| 风险项 | 影响 | 概率 | 缓解措施 |
-|-------|------|------|---------|
-| {风险 1} | 高/中/低 | 高/中/低 | {措施} |
-
-#### 6. 非目标与约束
-
-**6.1 非目标**：
-- 明确说明本次需求不包含的内容
-- 避免后续误解
-
-**6.2 知识库缺失识别**：
-| 缺失项 | 影响 | 补充计划 |
-|-------|------|---------|
-| {缺失 1} | {影响} | {计划} |
-
-#### 7. Open Questions
-
-| 问题 | 提出人 | 日期 | 状态 | 决议 |
-|------|--------|------|------|------|
-| {问题 1} | {人名} | {日期} | Open/Closed | {决议} |
-
----
-
-## WHEN-THEN 规格描述（Gherkin 风格）
-
-需求描述使用 WHEN-THEN 格式，确保无歧义：
-
-```gherkin
-场景：{场景名称}
-  给定：{前置条件}
-  当：{触发事件}
-  则：{预期结果}
-  而且：{额外预期}
-```
-
-### 示例
-
-```gherkin
-场景：用户购买产品
-  给定：用户账户余额充足
-    而且：当前账户状态正常
-  当：用户发起购买申请 100 元
-  则：创建购买订单，状态为"处理中"
-    而且：用户可用余额减少 100 元
-    而且：发送通知告知用户
-```
-
-### 使用规则
-
-1. **给定**：描述前置条件，必须可验证
-2. **当**：描述触发事件，必须具体
-3. **则**：描述预期结果，必须可测量
-4. **而且**：可多条，补充预期结果
-
----
-
-## 三板斧发布清单
-
-需求分析阶段必须考虑发布相关的三板斧：
-
-### 灰度策略
-
-| 灰度维度 | 说明 | 本需求适用 |
-|---------|------|-----------|
-| 用户灰度 | 按用户 ID/用户群灰度 | Y/N |
-| 流量灰度 | 按流量百分比分流 | Y/N |
-| 功能灰度 | 按功能开关控制 | Y/N |
-| 数据灰度 | 按数据范围灰度 | Y/N |
-
-### 监控指标
-
-| 指标类型 | 指标名称 | 告警阈值 | 本需求适用 |
-|---------|---------|---------|-----------|
-| 业务指标 | 下单成功率 | <95% | Y/N |
-| 性能指标 | 接口响应时间 | P99>500ms | Y/N |
-| 错误指标 | 错误日志数量 | >10/min | Y/N |
-| 资源指标 | CPU/内存使用率 | >80% | Y/N |
-
-### 应急预案
-
-| 风险项 | 应急操作 | 操作步骤 | 负责人 |
-|-------|---------|---------|--------|
-| 新功能异常 | 功能开关降级 | 1. 关闭开关 2. 验证恢复 | {人名} |
-| 性能问题 | 限流降级 | 1. 开启限流 2. 通知用户 | {人名} |
-| 数据问题 | 数据回滚 | 1. 停止写入 2. 回滚数据 | {人名} |
-
----
-
-## 需求澄清协议（DP17）
-
-发现需求歧义时，执行有界澄清：
-
-### Step 1: 11 维分类扫描
-
-| 维度 | 检查问题 |
-|------|---------|
-| 功能范围 | 要做什么功能？ |
-| 数据模型 | 涉及哪些数据实体？ |
-| UX 流程 | 用户如何交互？ |
-| 非功能需求 | 性能/安全/兼容性要求？ |
-| 集成接口 | 与哪些系统交互？ |
-| 边界案例 | 异常/极端情况如何处理？ |
-| 约束条件 | 有哪些技术/业务约束？ |
-| 术语定义 | 关键术语的定义？ |
-| 优先级 | 优先级如何排定？ |
-| 风险项 | 有哪些潜在风险？ |
-| 验收标准 | 如何判断需求完成？ |
-
-### Step 2: 按 Impact × Uncertainty 排序
-
-计算每个问题的优先级分数：
-- **Impact**（影响）：高 (3) / 中 (2) / 低 (1)
-- **Uncertainty**（不确定性）：高 (3) / 中 (2) / 低 (1)
-- **优先级分数** = Impact × Uncertainty
-
-### Step 3: 最多 5 个问题，逐个提问
-
-每个问题格式：
-```
-问题：{问题描述}
-AI 推荐答案：{推荐答案}
-推理过程：{为什么推荐这个答案}
-```
-
-### Step 4: 每个回答原子更新到需求文档
-
-- 澄清记录存入 `clarifications.md`
-- 更新需求文档中的对应章节
-- 标记澄清状态（已确认/待确认）
-
-**规则**：
-- 超过 5 个歧义 → 先澄清 Top 5，其余用知情猜测（DP5）
-- 自主模式下，AI 可直接采用推荐答案（仍需记录）
-
----
-
-## 需求检查清单
-
-### 必填章节检查
-
-- [ ] 1.1 业务背景
-- [ ] 1.2 业务价值
-- [ ] 2.1 目标
-- [ ] 2.2 范围
-- [ ] 3.2 需求用例图
-- [ ] 3.5 用例业务流程
-
-### 质量检查
-
-- [ ] 每条功能需求有明确的验收标准
-- [ ] 需求描述无歧义（不同人读到的理解一致）
-- [ ] 技术可行性已初步评估
-- [ ] 边界清晰（明确列出做什么、不做什么）
-- [ ] 非功能需求已覆盖（性能、安全、兼容性）
-- [ ] 依赖和约束已识别
-- [ ] 需求描述符合 5W 标准（Who/Where+When/What/Why）
-- [ ] 用户痛点已穿透至少两层
-- [ ] 客户价值公式成立（新方案 - 旧方案 - 转换成本>0）
-
-### 三板斧检查
-
-- [ ] 灰度策略已定义
-- [ ] 监控指标已定义
-- [ ] 应急预案已定义
-
----
-
-## 最佳实践
-
-1. **用例原子化**: 每个用例应该是原子的，不可再拆分
-2. **流程图优先**: 能用图表达的不用文字
-3. **明确边界**: 清晰定义包含和不包含的范围
-4. **关键决策记录**: 记录重要技术选型和方案取舍
-5. **风险前置**: 提前识别风险并制定缓解措施
-6. **WHEN-THEN 格式**: 用 Gherkin 风格描述需求，确保无歧义
-7. **三板斧思维**: 发布前必须考虑灰度、监控、应急
-
----
-
-## 参考资料
-
-- [proposal 模板](../templates/proposal.md)
-- [需求检查清单](../checklists/requirement.md)
-- [设计哲学 - 结构化澄清协议](../principles/design-philosophy.md#dp17-结构化澄清协议)
-- [设计哲学 - 三板斧](../principles/design-philosophy.md#dp10-安全与紧急制动)