@chongyan/autospec 1.0.1 → 1.0.2

package/knowledge/05-config/README.md

@@ -0,0 +1,132 @@
+# 配置目录
+
+> **定位**: 验证模式、团队触发器、角色配置等配置文件
+>
+> **进化分区**: 🟡 受控区（自动提议 + 人工批准）
+
+---
+
+## 目录结构
+
+```
+05-config/
+├── README.md                     # 本文件（配置目录导航）
+├── 00-validation-patterns.yaml   # 验证模式配置
+├── 01-team-stage.yaml            # 团队阶段配置（含触发器）
+├── 02-team-tasks.yaml            # 团队任务配置
+├── 03-role-composition.yaml      # 角色组合配置（含动态决策树）
+├── 04-role-extensions.yaml       # 角色扩展配置
+└── 05-skill-compositions.yaml    # 技能组合配置
+```
+
+---
+
+## 配置文件说明
+
+### 00-validation-patterns.yaml — 验证模式配置
+
+**内容**: 定义各阶段的验证模式和检查命令
+
+**核心配置**:
+- 构建检查（build-check）
+- 测试检查（test-check）
+- Lint 检查（lint-check）
+- 类型检查（type-check）
+
+**位置**: [00-validation-patterns.yaml](00-validation-patterns.yaml)
+
+### 01-team-stage.yaml — 团队阶段配置
+
+**内容**: 定义团队各阶段的准入准出标准，以及强制触发规则
+
+**核心配置**:
+- 阶段准入条件
+- 阶段准出标准
+- 阶段检查清单
+- 强制触发规则（mandatoryTriggers）
+
+**位置**: [01-team-stage.yaml](01-team-stage.yaml)
+
+### 02-team-tasks.yaml — 团队任务配置
+
+**内容**: 定义团队任务分配和流转规则
+
+**核心配置**:
+- 任务分配策略
+- 任务流转规则
+- 任务优先级定义
+
+**位置**: [02-team-tasks.yaml](02-team-tasks.yaml)
+
+### 03-role-composition.yaml — 角色组合配置
+
+**内容**: 定义团队角色组合和职责
+
+**核心配置**:
+- 角色定义
+- 角色职责
+- 角色协作模式
+
+**位置**: [03-role-composition.yaml](03-role-composition.yaml)
+
+### 04-role-extensions.yaml — 角色扩展配置
+
+**内容**: 定义角色扩展能力和技能
+
+**核心配置**:
+- 角色技能扩展
+- 角色能力矩阵
+- 角色成长路径
+
+**位置**: [04-role-extensions.yaml](04-role-extensions.yaml)
+
+### 05-skill-compositions.yaml — 技能组合配置
+
+**内容**: 定义技能组合和调用链
+
+**核心配置**:
+- 技能定义
+- 技能组合
+- 技能调用链
+
+**位置**: [05-skill-compositions.yaml](05-skill-compositions.yaml)
+
+---
+
+## 使用方式
+
+配置文件在 `autospec init` 时复制到 `.autospec/knowledge/05-config/`，可根据项目需求定制。
+
+```yaml
+# 验证模式示例
+patterns:
+  - name: "build-check"
+    stage: "implementation"
+    commands:
+      - "npm run build"
+    required: true
+
+# 团队触发器示例
+triggers:
+  - name: "code-review-request"
+    condition: "pull_request.opened"
+    actions:
+      - "notify: @team-lead"
+```
+
+---
+
+## 与相关文档的关系
+
+| 文档 | 说明 |
+|------|------|
+| [../02-process/](../02-process/) | 流程层（验证模式应用于各阶段） |
+| [../04-checklists/](../04-checklists/) | 检查清单（验证模式的具體化） |
+| [../08-organization/](../08-organization/) | 组织层（团队配置的依据） |
+
+---
+
+**维护者**: AutoSpec 团队
+**进化分区**: 🟡 受控区
+**版本**: v1.0
+**最后更新**: 2026-03-27

package/knowledge/06-environment/00-template-registry.md

@@ -0,0 +1,310 @@
+# 环境知识模板注册表
+
+> 定义环境知识的模板类型、来源和输出位置。供 env-sync、env-validate 命令引用。
+>
+> **版本**: v8.0
+> **最后更新**: 2026-03-29
+> **设计原则**: 高内聚低耦合，与 09-templates/ 一一对应
+
+---
+
+## 模板清单
+
+### 环境知识模板
+
+| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
+|---------|---------|---------|---------|
+| middleware | 10-middleware-knowledge.md | 01-env-knowledge/middleware/{name}.md | 基本信息、环境变量、连接代码模板、依赖信息、配置项详解、实际使用代码 |
+
+> **说明**: middleware 模板已整合外部服务类型（llm、auth、payment 等）。
+
+### 组件库模板
+
+| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
+|---------|---------|---------|---------|
+| component | 08-component-knowledge.md | 02-component-lib/components/{name}/component.md | 基本信息、接口定义、使用示例 |
+| best-practices | 09-best-practices.md | 02-component-lib/best-practices/{name}.md | 实践概述、实践分类、实施指南 |
+
+### 设计知识模板
+
+| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
+|---------|---------|---------|---------|
+| product-design | 00-requirement-proposal.md | 03-design-knowledge/product/{name}.md | 背景与价值、目标与范围、业务架构设计 |
+| architecture | 01-architecture-design.md | 03-design-knowledge/architecture/{name}.md | 架构愿景、逻辑架构、技术选型、服务依赖关系 |
+| api-design | 02-api-design.md | 03-design-knowledge/api/{name}.md | 接口概述、端点设计、RPC 接口设计、错误处理 |
+| database | 03-database-design.md | 03-design-knowledge/database/{name}.md | ER 图、表结构、索引设计、数据模型知识 |
+
+> **说明**:
+> - api-design 模板已整合 RPC 接口设计（支持 HTTP/RPC 多协议）
+> - database 模板已整合数据模型知识章节
+
+### 业务知识模板
+
+| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
+|---------|---------|---------|---------|
+| domain-business | 05-domain-business.md | 04-business-knowledge/{name}.md | 业务术语表、业务规则、业务流程、领域模型、实体详情 |
+
+> **说明**: domain-business 模板整合了业务知识（术语、规则、流程）与领域模型（DDD，含数据模型），遵循高内聚原则。
+
+### 测试知识模板
+
+| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
+|---------|---------|---------|---------|
+| test-design | 06-test-design.md | 05-test-knowledge/test-designs/{name}.md | 测试概要、测试用例、覆盖矩阵 |
+| evaluation | 07-evaluation-design.md | 05-test-knowledge/evaluation/{name}.md | 评测目标、数据集、指标、Badcase 分析 |
+
+---
+
+## 模板分类
+
+| 分类 | 说明 | 模板列表 |
+|------|------|---------|
+| `01-env-knowledge/` | 环境知识 | middleware |
+| `02-component-lib/` | 组件库 | component, best-practices |
+| `03-design-knowledge/` | 设计知识 | product-design, architecture, api-design, database |
+| `04-business-knowledge/` | 业务知识 | domain-business |
+| `05-test-knowledge/` | 测试知识 | test-design, evaluation |
+
+---
+
+## 类型枚举
+
+### 中间件类型
+
+| 类型 | 说明 | 典型示例 |
+|------|------|---------|
+| 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. 校验必填章节完整性
+6. 注册到 registry.json
+
+**增量同步**:
+1. 检测 Git 变更（依赖/代码/配置）
+2. 确定受影响的知识文件
+3. 仅重新扫描变更项
+4. 执行置信度过滤
+5. 校验后更新注册表
+
+**置信度处理**:
+
+| 置信度范围 | 级别 | 处理方式 |
+|-----------|------|---------|
+| ≥ 0.85 | 高 | 直接采用，自动生成知识文件 |
+| 0.65 - 0.85 | 中 | 标记「待确认」，生成文件但添加 review 标记 |
+| 0.45 - 0.65 | 低 | 仅记录到扫描结果，不生成知识文件 |
+| < 0.45 | 忽略 | 不记录 |
+
+**知识过期检测**:
+- 知识文件超过 30 天未更新 → 标记「可能过期」
+- 源文件变更后 24 小时内知识未更新 → 标记「需要同步」
+
+### 研发模板同步（proposal/design/task/testcase）
+
+**模板加载**:
+1. 从 `knowledge/09-templates/` 读取模板文件
+2. 解析模板中的占位符（如 `{需求名称}`）
+3. 根据用户输入填充占位符
+4. 输出到目标位置
+
+**模板验证**:
+1. 检查必填章节是否存在
+2. 检查占位符是否全部填充
+3. 检查 Markdown 格式是否正确
+
+### 规范文档同步（standards）
+
+**规范加载**:
+1. 从 `knowledge/07-standards/` 读取规范文件
+2. 解析规范中的检查项
+3. 集成到 code-review 流程中
+
+**规范更新**:
+1. 定期 review 规范文档
+2. 根据实践反馈更新规范
+3. 更新后通知所有使用者
+
+---
+
+## 校验规则
+
+### 章节完整性校验
+
+检查 MD 文件是否包含所有必填章节：
+
+```
+middleware:
+  - "## 基本信息"
+  - "## 环境变量"
+  - "## 连接代码模板"
+
+component:
+  - "## 基本信息"
+  - "## 接口定义"
+  - "## 使用示例"
+```
+
+### 表格格式校验
+
+- 表格必须有表头行
+- 表格列数必须一致
+- 必填表格不能为空
+
+### 类型枚举校验
+
+- 中间件类型必须在预定义枚举中
+- 组件类型必须在预定义枚举中
+
+---
+
+## AI 生成参考
+
+### 环境知识生成
+
+| 场景 | 参考文件 |
+|------|---------|
+| 扫描检测 | `knowledge/03-guides/27-scan-environment.md` |
+| 知识生成 | `knowledge/03-guides/29-generate-knowledge.md` |
+| 检测规则 | `knowledge/06-environment/01-detection-patterns.yaml` |
+
+### 研发文档生成
+
+| 场景 | 参考文件 |
+|------|---------|
+| 需求提案 | `knowledge/02-process/01-requirement.md` + `knowledge/09-templates/product-proposal.md` |
+| 系统设计 | `knowledge/02-process/02-design.md` + `knowledge/09-templates/system-design.md` |
+| 任务分解 | `knowledge/02-process/03-implementation.md` + `knowledge/09-templates/task-breakdown.md` |
+| 测试用例 | `knowledge/02-process/04-test.md` + `knowledge/09-templates/test-case.md` |
+| DDD设计 | `knowledge/03-guides/42-apply-ddd.md` + `knowledge/09-templates/domain-driven-design.md` |
+
+### 规范文档引用
+
+| 场景 | 参考文件 |
+|------|---------|
+| 编码规范 | `knowledge/07-standards/00-coding-style.md` |
+| 数据一致性 | `knowledge/07-standards/02-data-consistency.md` |
+| Code Review | `knowledge/07-standards/01-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/ 分类 |
+| v7.0 | 2026-03-29 | 模板深度整合：RPC 合并到 api-design，数据模型合并到 database-design，业务知识整合为 domain-business |
+| v8.0 | 2026-03-29 | 目录结构精简：移除冗余目录，与 09-templates/ 一一对应，RPC 服务合并到 api/，数据模型合并到 business-knowledge/ |
+
+---
+
+**维护者**: AutoSpec 团队
+**进化分区**: 🟡 受控区
+**关联文档**: `knowledge/06-environment/README.md`