@chongyan/autospec 1.0.1 → 1.0.2

package/knowledge/domain/glossary.md

@@ -1,143 +0,0 @@
-# 业务术语表
-
-> 统一业务概念定义，消除沟通歧义。
-
-## 使用说明
-
-1. 每个术语包含：术语名、英文缩写、定义、相关术语、来源
-2. 需求分析阶段自动从需求文档提取候选术语
-3. 术语定义冲突时，以本文档为准
-
-## 术语列表
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-> 空表格，由各项目自行填充
-
-## 自动提取规则
-
-从需求文档中识别候选术语：
-
-| 提取条件 | 说明 |
-|---------|------|
-| 高频词 | 出现次数 > 3 |
-| 首字母缩写 | 如 API、SDK、CRUD |
-| 专用名词 | 如"XX系统"、"XX模块" |
-| 业务概念 | 具有特定业务含义的词 |
-
-提取后需人工确认定义。
-
-## 术语分类
-
-建议按以下分类组织术语：
-
-### 业务实体
-
-业务操作的核心对象，如：订单、用户、商品...
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-### 业务动作
-
-业务操作的行为，如：下单、支付、发货...
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-### 业务状态
-
-业务对象的状态，如：待支付、已支付、已取消...
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-### 业务规则
-
-业务约束条件，如：限额、时效、条件...
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-### 领域模型术语（DDD增强）
-
-领域驱动设计核心概念，用于复杂业务建模。
-
-| 术语 | 缩写 | 定义 | 适用上下文 | 来源 |
-|-----|------|------|-----------|------|
-| 聚合 Aggregate | AGG | 一致性边界内的对象集合，包含实体和值对象 | 设计阶段 | DDD |
-| 聚合根 Aggregate Root | AR | 聚合的唯一入口实体，负责维护聚合内部一致性 | 设计阶段 | DDD |
-| 实体 Entity | - | 有唯一标识的领域对象，具有生命周期和可变状态 | 设计阶段 | DDD |
-| 值对象 Value Object | VO | 无唯一标识、不可变的对象，通过属性值判断相等性 | 设计阶段 | DDD |
-| 领域事件 Domain Event | DE | 领域中发生的业务事实，用于聚合间通信 | 设计阶段 | DDD |
-| 领域服务 Domain Service | DS | 不属于任何实体或值对象的无状态领域操作 | 设计阶段 | DDD |
-| 仓储 Repository | - | 聚合的持久化抽象，提供集合语义的查询和保存 | 设计阶段 | DDD |
-| 工厂 Factory | - | 封装复杂对象创建逻辑，解耦创建与使用 | 设计阶段 | DDD |
-
-### 限界上下文术语（DDD增强）
-
-限界上下文是语言一致性边界，每个上下文有独立的统一语言。
-
-| 术语 | 缩写 | 定义 | 所属上下文 | 来源 |
-|-----|------|------|-----------|------|
-| 限界上下文 Bounded Context | BC | 语言一致性边界，边界内术语含义统一 | 战略设计 | DDD |
-| 上下文映射 Context Map | CM | 描述限界上下文之间关系的图示 | 战略设计 | DDD |
-| 核心域 Core Domain | - | 业务核心竞争力，必须自研重点投入 | 战略设计 | DDD |
-| 支撑域 Supporting Domain | - | 支撑核心业务的能力，可外包 | 战略设计 | DDD |
-| 通用域 Generic Domain | - | 通用能力，可用现成方案 | 战略设计 | DDD |
-| 防腐层 Anticorruption Layer | ACL | 隔离外部模型的适配层，保护内部模型纯净 | 上下文集成 | DDD |
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-### 业务动作
-
-业务操作的行为，如：下单、支付、发货...
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-### 业务状态
-
-业务对象的状态，如：待支付、已支付、已取消...
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-### 业务规则
-
-业务约束条件，如：限额、时效、条件...
-
-| 术语 | 缩写 | 定义 | 相关术语 | 来源 |
-|-----|------|------|---------|------|
-| | | | | |
-
-## 术语冲突处理
-
-当发现术语定义冲突时：
-
-1. **记录冲突**：在需求分析阶段标记
-2. **澄清确认**：与业务方确认准确定义
-3. **更新文档**：更新本文档，标注变更历史
-4. **通知相关方**：通知设计、开发、测试团队
-
-## 版本历史
-
-| 版本 | 日期 | 修改人 | 修改说明 |
-|-----|------|--------|---------|
-| v1.0 | YYYY-MM-DD | | 初始版本 |
-
----
-
-**维护者**: 项目团队
-**进化分区**: 自由区
-**关联文档**: `knowledge/domain/rules.md`

package/knowledge/domain/rules.md

@@ -1,138 +0,0 @@
-# 业务规则库
-
-> 规则ID化，便于追溯和校验。
-
-## 规则格式
-
-每个业务规则包含：
-
-| 字段 | 说明 | 必填 |
-|------|------|------|
-| 规则ID | BR-{NN} 格式，便于追溯 | ✅ |
-| 规则名称 | 简短描述 | ✅ |
-| 规则描述 | 详细说明规则内容 | ✅ |
-| 适用场景 | 何时需要遵守此规则 | ✅ |
-| 校验方式 | 如何检验是否遵守 | ✅ |
-| 来源 | 需求文档章节/业务方确认 | ❌ |
-| 优先级 | P0/P1/P2 | ❌ |
-
-## 规则列表
-
-> 空表格，由各项目自行填充
-
-| 规则ID | 规则名称 | 规则描述 | 适用场景 | 校验方式 | 来源 | 优先级 |
-|--------|---------|---------|---------|---------|------|--------|
-| | | | | | | |
-
-## 规则分类
-
-### 数据校验规则
-
-数据有效性约束，如：格式、范围、必填...
-
-| 规则ID | 规则名称 | 规则描述 | 适用场景 | 校验方式 |
-|--------|---------|---------|---------|---------|
-| | | | | |
-
-### 业务逻辑规则
-
-业务流程约束，如：状态流转、条件判断...
-
-| 规则ID | 规则名称 | 规则描述 | 适用场景 | 校验方式 |
-|--------|---------|---------|---------|---------|
-| | | | | |
-
-### 安全合规规则
-
-安全与合规约束，如：权限、审计、脱敏...
-
-| 规则ID | 规则名称 | 规则描述 | 适用场景 | 校验方式 |
-|--------|---------|---------|---------|---------|
-| | | | | |
-
-### 性能约束规则
-
-性能相关约束，如：响应时间、并发量...
-
-| 规则ID | 规则名称 | 规则描述 | 适用场景 | 校验方式 |
-|--------|---------|---------|---------|---------|
-| | | | | |
-
-### 领域模型规则（DDD增强）
-
-领域驱动设计相关规则，适用于复杂业务系统建模。
-
-| 规则ID | 规则名称 | 规则描述 | 适用场景 | 校验方式 | 来源 |
-|--------|---------|---------|---------|---------|------|
-| DDD-01 | 聚合边界一致性 | 聚合内部必须保证强一致性，单个聚合=单个事务 | 聚合设计 | 代码审查 | DDD |
-| DDD-02 | 聚合根唯一入口 | 外部只能通过聚合根访问聚合内部，不可直接操作内部实体 | 代码实现 | 代码审查 | DDD |
-| DDD-03 | 跨聚合ID引用 | 聚合之间只能通过ID引用，不能直接持有其他聚合对象引用 | 代码实现 | 代码审查 | DDD |
-| DDD-04 | 领域事件幂等 | 事件处理必须幂等，同一事件多次处理结果相同 | 事件处理 | 测试验证 | DDD |
-| DDD-05 | 统一语言一致性 | 代码命名必须与业务术语一致，消除沟通歧义 | 全流程 | 术语表对照 | DDD |
-| DDD-06 | 聚合大小控制 | 聚合应保持小规模，避免并发冲突和性能问题 | 聚合设计 | 设计评审 | DDD |
-| DDD-07 | 仓储查询限制 | 仓储只按聚合根ID查询，不暴露复杂查询能力 | 仓储设计 | 接口审查 | DDD |
-| DDD-08 | 领域服务无状态 | 领域服务必须无状态，不持有聚合实例 | 服务设计 | 代码审查 | DDD |
-| DDD-09 | 事件命名规范 | 领域事件命名使用过去时，如OrderCreated、PaymentCompleted | 事件定义 | 命名检查 | DDD |
-| DDD-10 | 值对象不可变 | 值对象必须不可变，修改应返回新实例 | 值对象设计 | 代码审查 | DDD |
-
-## 使用方式
-
-### 需求分析阶段
-
-1. 从需求文档提取业务规则
-2. 分配规则ID（BR-01, BR-02...）
-3. 填写规则详情
-4. 标注来源和优先级
-
-### 方案设计阶段
-
-1. 设计方案时明确如何满足每条规则
-2. 在设计文档中引用规则ID
-3. 记录规则满足方式
-
-### 代码审查阶段
-
-1. 检查代码是否遵循业务规则
-2. 对照规则ID逐项验证
-3. 记录未遵循的规则
-
-### 测试用例阶段
-
-1. 为每条规则设计测试场景
-2. 正向用例：规则满足场景
-3. 反向用例：规则违反场景
-
-## 规则校验方式
-
-| 校验方式 | 说明 | 示例 |
-|---------|------|------|
-| 代码检查 | 静态分析代码逻辑 | Lint规则、类型检查 |
-| 测试用例 | 编写测试验证规则 | 单元测试、集成测试 |
-| 数据校验 | 运行时数据检查 | 数据库约束、接口校验 |
-| 人工审查 | 需要人工判断 | 代码Review、业务验收 |
-
-## 规则变更流程
-
-```
-识别变更需求 → 评估影响范围 → 更新规则定义 → 通知相关方 → 更新代码/测试
-```
-
-### 变更类型
-
-| 类型 | 说明 | 审批要求 |
-|------|------|---------|
-| 新增规则 | 新增业务约束 | 无需审批，记录即可 |
-| 修改规则 | 修改规则内容 | 需评估影响范围 |
-| 废弃规则 | 规则不再适用 | 需确认无依赖后废弃 |
-
-## 版本历史
-
-| 版本 | 日期 | 修改人 | 修改说明 |
-|-----|------|--------|---------|
-| v1.0 | YYYY-MM-DD | | 初始版本 |
-
----
-
-**维护者**: 项目团队
-**进化分区**: 受控区
-**关联文档**: `knowledge/domain/glossary.md`, `knowledge/domain/flows/README.md`

package/knowledge/environment/component-knowledge.md

@@ -1,316 +0,0 @@
-# 组件知识模板
-
-> 本模板定义组件知识的标准格式。供 env-sync 生成知识文件时参考。
-
----
-
-## 文件位置
-
-`.autospec/environment/component-lib/components/{name}/component.md`
-
----
-
-## 基本信息
-
-| 字段 | 必填 | 说明 |
-|------|------|------|
-| 名称 | 是 | 组件名称，如 auth、payment |
-| 类型 | 是 | 参见类型枚举 |
-| 版本 | 是 | 组件版本，如 v2.1.0 |
-| 维护者 | 否 | 维护团队或个人 |
-| 最后更新 | 否 | 更新日期 |
-
-### 类型枚举
-
-| 类型 | 说明 | 典型示例 |
-|------|------|---------|
-| service-component | 服务组件，封装外部服务调用 | 认证组件、支付网关 |
-| utility | 工具组件，提供通用功能 | 日志组件、配置组件 |
-| library | 库组件，封装业务逻辑 | 领域模型、数据访问层 |
-
----
-
-## 功能描述
-
-简要描述组件的核心功能和用途。
-
----
-
-## 接口定义
-
-| 方法名 | 说明 |
-|--------|------|
-| {method1} | 方法说明 |
-| {method2} | 方法说明 |
-
-### 方法详情
-
-#### {method1}
-
-**输入参数**
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| param1 | string | 是 | 参数说明 |
-| param2 | number | 否 | 参数说明 |
-
-**输出参数**
-
-| 字段名 | 类型 | 说明 |
-|--------|------|------|
-| result | any | 返回结果 |
-
-**错误码**
-
-| 错误码 | 说明 |
-|--------|------|
-| ERROR_CODE_1 | 错误描述 |
-| ERROR_CODE_2 | 错误描述 |
-
----
-
-## 使用示例
-
-按语言分节，提供安装命令和代码示例。
-
-### Node.js
-
-**安装**
-
-```bash
-npm install @org/component-name
-```
-
-**使用**
-
-```javascript
-import { Component } from '@org/component-name';
-
-const component = new Component({
-  endpoint: process.env.COMPONENT_ENDPOINT,
-  timeout: 30000
-});
-
-// 调用方法
-const result = await component.method1(param1, param2);
-```
-
-### Python
-
-**安装**
-
-```bash
-pip install org-component
-```
-
-**使用**
-
-```python
-from org_component import Component
-
-component = Component(
-    endpoint=os.environ['COMPONENT_ENDPOINT'],
-    timeout=30000
-)
-
-# 调用方法
-result = component.method1(param1, param2)
-```
-
----
-
-## 配置项
-
-### 必需配置
-
-| 配置项 | 说明 |
-|--------|------|
-| CONFIG_ENDPOINT | 服务地址 |
-| CONFIG_API_KEY | API密钥 |
-
-### 可选配置
-
-| 配置项 | 默认值 | 说明 |
-|--------|--------|------|
-| CONFIG_TIMEOUT | 30 | 超时时间(秒) |
-| CONFIG_RETRY | 3 | 重试次数 |
-
----
-
-## 环境差异配置
-
-| 环境 | 配置项 | 值 |
-|------|--------|-----|
-| development | CONFIG_ENDPOINT | http://dev.example.com |
-| staging | CONFIG_ENDPOINT | http://staging.example.com |
-| production | CONFIG_ENDPOINT | http://api.example.com |
-
----
-
-## 使用检查清单
-
-### 使用前检查
-
-- [ ] 确认依赖服务已部署且可访问
-- [ ] 确认必需环境变量已配置
-- [ ] 确认应用已注册到服务
-
-### 使用后检查
-
-- [ ] 验证核心功能正常
-- [ ] 验证错误处理正确
-- [ ] 验证日志记录完整
-
----
-
-## 最佳实践
-
-1. 使用前检查服务可用性
-2. 实现完善的错误处理
-3. 记录关键操作日志
-4. 设置合理的超时时间
-
----
-
-## 反模式清单
-
-| 反模式 | 风险 | 替代方案 |
-|--------|------|----------|
-| 硬编码服务地址 | 环境切换困难 | 使用环境变量 |
-| 忽略错误处理 | 系统不稳定 | 实现完善的错误处理 |
-| 不设置超时 | 请求阻塞 | 设置合理的超时时间 |
-
----
-
-## 示例：认证组件知识
-
-```markdown
-# 认证组件知识
-
-## 基本信息
-
-| 字段 | 值 |
-|------|-----|
-| 名称 | auth |
-| 类型 | service-component |
-| 版本 | v2.1.0 |
-| 维护者 | platform-team |
-
-## 功能描述
-
-统一认证组件，支持 JWT Token、OAuth2.0、Session 等多种认证方式。
-提供用户登录、登出、Token 刷新、权限校验等核心功能。
-
-## 接口定义
-
-| 方法名 | 说明 |
-|--------|------|
-| login | 用户登录 |
-| validateToken | 验证Token |
-| logout | 用户登出 |
-
-### 方法详情
-
-#### login
-
-**输入参数**
-
-| 参数名 | 类型 | 必填 | 说明 |
-|--------|------|------|------|
-| username | string | 是 | 用户名 |
-| password | string | 是 | 密码 |
-
-**输出参数**
-
-| 字段名 | 类型 | 说明 |
-|--------|------|------|
-| success | boolean | 是否成功 |
-| token | string | Token（成功时） |
-| errorCode | string | 错误码（失败时） |
-
-**错误码**
-
-| 错误码 | 说明 |
-|--------|------|
-| AUTH_FAILED | 用户名或密码错误 |
-| ACCOUNT_LOCKED | 账户已被锁定 |
-
-## 使用示例
-
-### Node.js
-
-**安装**
-
-```bash
-npm install @acme/auth-client
-```
-
-**使用**
-
-```javascript
-import { AuthClient } from '@acme/auth-client';
-
-const authClient = new AuthClient({
-  endpoint: process.env.AUTH_SERVICE_ENDPOINT,
-  redisUrl: process.env.REDIS_URL
-});
-
-// 登录
-const result = await authClient.login(username, password);
-
-// 验证Token
-const user = await authClient.validateToken(token);
-
-// 登出
-await authClient.logout(token);
-```
-
-## 配置项
-
-### 必需配置
-
-| 配置项 | 说明 |
-|--------|------|
-| AUTH_SERVICE_ENDPOINT | 认证服务地址 |
-| REDIS_URL | Redis连接地址 |
-
-### 可选配置
-
-| 配置项 | 默认值 | 说明 |
-|--------|--------|------|
-| AUTH_TOKEN_EXPIRY | 3600 | Token过期时间(秒) |
-| AUTH_MAX_RETRY | 3 | 最大重试次数 |
-
-## 使用检查清单
-
-### 使用前检查
-
-- [ ] 确认Redis已部署且可访问
-- [ ] 确认AUTH_SERVICE_ENDPOINT环境变量已配置
-- [ ] 确认应用已注册到认证服务
-
-### 使用后检查
-
-- [ ] 验证登录流程正常
-- [ ] 验证Token刷新机制
-- [ ] 验证权限校验正确
-```
-
----
-
-## 自检清单
-
-生成组件知识文件后，检查以下项目：
-
-- [ ] 基本信息章节完整，包含名称、类型、版本
-- [ ] 功能描述清晰
-- [ ] 接口定义包含方法名和参数说明
-- [ ] 使用示例包含安装命令和代码
-- [ ] 配置项包含必需和可选配置
-- [ ] 使用检查清单完整
-
----
-
-**维护者**: AutoSpec 团队
-**进化分区**: 🟡 受控区
-**关联文档**: `knowledge/environment/template-registry.md`