@chongyan/autospec 1.0.1 → 1.0.2

package/knowledge/09-templates/README.en.md

@@ -0,0 +1,222 @@
+# Document Templates
+
+> **Purpose**: Standardized document templates to ensure consistent output format and complete content
+>
+> **Evolution Zone**: 🟡 Controlled (Auto-proposed + Human-approved)
+
+---
+
+## Directory Structure
+
+```
+09-templates/
+├── README.md                     # This file (Templates Navigation)
+├── 00-requirement-proposal.md  # Requirement Proposal Template
+├── 01-architecture-design.md    # Architecture Design Template
+├── 02-api-design.md             # API Design Template
+├── 03-database-design.md        # Database Design Template
+├── 04-product-design.md         # Product Design Template
+├── 05-business-glossary.md      # Business Glossary Template
+├── 06-business-rules.md         # Business Rules Template
+├── 07-business-flows.md         # Business Flows Template
+├── 08-test-design.md            # Test Design Template
+├── 09-evaluation-design.md      # Evaluation Design (AI/Model)
+├── 10-component-knowledge.md    # Component Knowledge Template
+├── 11-best-practices.md         # Best Practices Template
+├── 12-domain-model.md           # Domain Model Template
+└── 13-middleware-knowledge.md   # Middleware Knowledge Template
+```
+
+---
+
+## Template Description
+
+### 01-architecture-design.md — Architecture Design Template
+
+**Content**: System architecture design document template with architecture vision, logical architecture, physical architecture, technology selection, and quality attributes
+
+**Core Chapters**:
+- Architecture Vision
+- Logical Architecture (Mermaid Class/Component Diagrams)
+- Physical Architecture (Deployment Diagram)
+- Technology Selection
+- Quality Attribute Design
+
+**Location**: [01-architecture-design.md](01-architecture-design.md)
+
+### 02-api-design.md — API Design Template
+
+**Content**: Standardized API design document template following OpenAPI Specification v3.0
+
+**Core Chapters**:
+- API Overview
+- Resource Definition
+- Endpoint Details (Request/Response/Error Codes)
+- Authentication & Authorization
+- Rate Limiting & Degradation
+- Version History
+
+**Location**: [02-api-design.md](02-api-design.md)
+
+### 03-database-design.md — Database Design Template
+
+**Content**: Database design document template with conceptual, logical, and physical models
+
+**Core Chapters**:
+- Conceptual Model (ER Diagram)
+- Logical Model (Table Schema)
+- Physical Model (Index/Partition)
+- DDL Scripts
+- Performance Optimization
+
+**Location**: [03-database-design.md](03-database-design.md)
+
+### 04-product-design.md — Product Design Template
+
+**Content**: Product design document template with user research, requirements definition, and feature design
+
+**Core Chapters**:
+- User Research
+- Requirements Definition
+- Feature Design
+- Prototype Design
+- Acceptance Criteria
+
+**Location**: [04-product-design.md](04-product-design.md)
+
+### 05-business-glossary.md — Business Glossary Template
+
+**Content**: Business glossary template following DDD Ubiquitous Language principles
+
+**Core Chapters**:
+- Terminology List
+- Term Definitions
+- Term Relationships
+- Usage Context
+
+**Location**: [05-business-glossary.md](05-business-glossary.md)
+
+### 06-business-rules.md — Business Rules Template
+
+**Content**: Business rules document template with decision tables and rule validation
+
+**Core Chapters**:
+- Rules List
+- Decision Tables
+- Rule Validation
+- Violation Handling
+
+**Location**: [06-business-rules.md](06-business-rules.md)
+
+### 07-business-flows.md — Business Flows Template
+
+**Content**: Business process document template using BPMN 2.0 flow modeling
+
+**Core Chapters**:
+- Flow Overview
+- Flow Diagrams (Mermaid)
+- Roles & Responsibilities
+- Exception Flows
+
+**Location**: [07-business-flows.md](07-business-flows.md)
+
+### 08-test-design.md — Test Design Template
+
+**Content**: Test design document template following ISTQB standards
+
+**Core Chapters**:
+- Test Strategy
+- Test Pyramid
+- Test Cases
+- Coverage Matrix
+
+**Location**: [08-test-design.md](08-test-design.md)
+
+### 09-evaluation-design.md — Evaluation Design Template
+
+**Content**: AI/Model effect evaluation document template
+
+**Core Chapters**:
+- Evaluation Objective
+- Evaluation Dataset
+- Evaluation Metrics (Accuracy/Precision/Recall/F1)
+- Evaluation Execution
+- Badcase Analysis
+
+**Location**: [09-evaluation-design.md](09-evaluation-design.md)
+
+### 10-component-knowledge.md — Component Knowledge Template
+
+**Content**: Component library knowledge document template with multi-language support
+
+**Core Chapters**:
+- Component Overview
+- Installation
+- Quick Start
+- API Definition
+- Usage Examples
+- Best Practices
+
+**Location**: [10-component-knowledge.md](10-component-knowledge.md)
+
+### 11-best-practices.md — Best Practices Template
+
+**Content**: Best practices document template with case studies and implementation guides
+
+**Core Chapters**:
+- Practice Overview
+- Practice Classification
+- Practice Details
+- Comparative Analysis
+- Implementation Guide
+- Case Studies
+
+**Location**: [11-best-practices.md](11-best-practices.md)
+
+### 12-domain-model.md — Domain Model Template
+
+**Content**: Domain model document template following DDD methodology
+
+**Core Chapters**:
+- Domain Overview
+- Domain Model (Class Diagram)
+- Entity Details
+- Domain Relationships
+- Domain Events
+- Domain Services
+
+**Location**: [12-domain-model.md](12-domain-model.md)
+
+---
+
+## Usage
+
+Templates are applied in the following scenarios:
+
+1. **Architecture Design**: Use `01-architecture-design.md`
+2. **API Design**: Use `02-api-design.md`
+3. **Database Design**: Use `03-database-design.md`
+4. **Product Design**: Use `04-product-design.md`
+5. **Business Knowledge**: Use `05-business-glossary.md`, `06-business-rules.md`, `07-business-flows.md`
+6. **Test Design**: Use `08-test-design.md`
+7. **AI Evaluation**: Use `09-evaluation-design.md`
+8. **Component Knowledge**: Use `10-component-knowledge.md`
+9. **Best Practices**: Use `11-best-practices.md`
+10. **Domain Modeling**: Use `12-domain-model.md`
+
+---
+
+## Related Documents
+
+| Document | Description |
+|----------|-------------|
+| [../02-process/02-design.md](../02-process/02-design.md) | Solution Design Stage |
+| [../03-guides/03-design-solution.md](../03-guides/03-design-solution.md) | Design Skills |
+| [../04-checklists/02-design.md](../04-checklists/02-design.md) | Design Checklist |
+
+---
+
+**Maintainer**: AutoSpec Team
+**Evolution Zone**: 🟡 Controlled
+**Version**: v2.0
+**Last Updated**: 2026-03-27

package/knowledge/09-templates/README.md

@@ -0,0 +1,216 @@
+# 文档模板
+
+> **定位**: 标准化文档模板，确保产出物格式统一、内容完整
+>
+> **进化分区**: 🟡 受控区（自动提议 + 人工批准）
+
+---
+
+## 目录结构
+
+```
+09-templates/
+├── README.md                     # 本文件（文档模板导航）
+├── 00-requirement-proposal.md    # 需求提案模板
+├── 01-architecture-design.md     # 架构设计模板（含服务依赖）
+├── 02-api-design.md              # API 设计模板（含 RPC）
+├── 03-database-design.md         # 数据库设计模板（含数据模型）
+├── 04-product-design.md          # 产品设计模板
+├── 05-domain-business.md         # 领域与业务知识模板（整合术语/规则/流程/领域模型）
+├── 06-test-design.md             # 测试设计模板
+├── 07-evaluation-design.md       # 评测设计模板（AI/模型）
+├── 08-component-knowledge.md     # 组件知识模板
+├── 09-best-practices.md          # 最佳实践模板
+└── 10-middleware-knowledge.md    # 中间件知识模板（含外部服务）
+```
+
+---
+
+## 模板与输出目录对应关系
+
+| 模板文件 | 输出目录 | 说明 |
+|---------|---------|------|
+| 10-middleware-knowledge.md | 01-env-knowledge/middleware/ | 中间件知识（含外部服务） |
+| 08-component-knowledge.md | 02-component-lib/components/ | 组件知识 |
+| 09-best-practices.md | 02-component-lib/best-practices/ | 最佳实践 |
+| 00-requirement-proposal.md | 03-design-knowledge/product/ | 需求提案 |
+| 04-product-design.md | 03-design-knowledge/product/ | 产品设计 |
+| 01-architecture-design.md | 03-design-knowledge/architecture/ | 架构设计（含服务依赖） |
+| 02-api-design.md | 03-design-knowledge/api/ | API 设计（含 RPC） |
+| 03-database-design.md | 03-design-knowledge/database/ | 数据库设计 |
+| 05-domain-business.md | 04-business-knowledge/ | 领域与业务知识（含数据模型） |
+| 06-test-design.md | 05-test-knowledge/test-designs/ | 测试设计 |
+| 07-evaluation-design.md | 05-test-knowledge/evaluation/ | 评测设计 |
+
+---
+
+## 模板说明
+
+### 00-requirement-proposal.md — 需求提案模板
+
+**内容**: 需求分析与提案文档模板，包含业务背景、架构设计、关键决策、风险分析
+
+**核心章节**:
+- 业务背景与目标
+- 需求范围（When-Then 规格）
+- 业务架构设计
+- 关键决策与方案对比
+- 风险与缓解措施
+- 三板斧发布清单（灰度/监控/应急）
+- 需求澄清协议（DP17 结构化澄清）
+
+**适用场景**: 新需求立项分析、复杂需求拆解、需求评审材料
+
+### 01-architecture-design.md — 架构设计模板
+
+**内容**: 系统架构设计文档模板，包含架构愿景、逻辑架构、物理架构、技术选型、服务依赖关系
+
+**核心章节**:
+- 架构愿景
+- 逻辑架构（Mermaid 类图/组件图）
+- 物理架构（部署图）
+- 技术选型
+- 服务依赖关系
+- 质量属性设计
+
+### 02-api-design.md — API 设计模板
+
+**内容**: 规范化接口设计文档模板，支持 HTTP API 和 RPC 接口
+
+**核心章节**:
+- 接口概述
+- 端点详情（请求/响应/错误码）
+- RPC 接口设计
+- 认证授权
+- 限流降级
+- 版本历史
+
+### 03-database-design.md — 数据库设计模板
+
+**内容**: 数据库设计文档模板，包含概念模型、逻辑模型、物理模型、数据模型知识
+
+**核心章节**:
+- 概念模型（ER 图）
+- 逻辑模型（表结构）
+- 物理模型（索引/分区）
+- DDL 脚本
+- 数据模型知识
+- 性能优化
+
+### 04-product-design.md — 产品设计模板
+
+**内容**: 产品设计文档模板，包含用户研究、需求定义、功能设计
+
+**核心章节**:
+- 用户研究
+- 需求定义
+- 功能设计
+- 原型设计
+- 验收标准
+
+### 05-domain-business.md — 领域与业务知识模板
+
+**内容**: 整合业务术语、业务规则、业务流程、领域模型（含数据模型）的综合模板
+
+**核心章节**:
+- 业务术语表（统一语言）
+- 业务规则
+- 业务流程
+- 领域模型（含数据模型）
+- 实体详情
+- 领域关系
+- 领域事件
+
+**整合来源**: 原 business-glossary、business-rules、business-flows、domain-model 模板
+
+### 06-test-design.md — 测试设计模板
+
+**内容**: 测试设计文档模板，遵循 ISTQB 标准
+
+**核心章节**:
+- 测试策略
+- 测试金字塔
+- 测试用例
+- 覆盖矩阵
+
+### 07-evaluation-design.md — 评测设计模板
+
+**内容**: AI/模型效果评测文档模板
+
+**核心章节**:
+- 评测目标
+- 评测数据集
+- 评测指标（准确率/精确率/召回率/F1）
+- 评测执行
+- Badcase 分析
+
+### 08-component-knowledge.md — 组件知识模板
+
+**内容**: 组件库知识文档模板，支持多语言
+
+**核心章节**:
+- 组件概述
+- 安装方式
+- 快速开始
+- 接口定义
+- 使用示例
+- 最佳实践
+
+### 09-best-practices.md — 最佳实践模板
+
+**内容**: 最佳实践文档模板，包含案例研究、实施指南
+
+**核心章节**:
+- 实践概述
+- 实践分类
+- 实践详情
+- 对比分析
+- 实施指南
+- 案例研究
+
+### 10-middleware-knowledge.md — 中间件知识模板
+
+**内容**: 中间件知识文档模板，含外部服务（LLM、认证、支付等）
+
+**核心章节**:
+- 基本信息
+- 环境变量
+- 连接代码模板
+- 依赖信息
+- 配置项详解
+- 实际使用代码
+
+---
+
+## 使用方式
+
+模板在以下场景应用：
+
+1. **需求分析**: 使用 `00-requirement-proposal.md`
+2. **架构设计**: 使用 `01-architecture-design.md`
+3. **接口设计**: 使用 `02-api-design.md`（含 RPC）
+4. **数据库设计**: 使用 `03-database-design.md`（含数据模型）
+5. **产品设计**: 使用 `04-product-design.md`
+6. **业务知识**: 使用 `05-domain-business.md`（整合术语/规则/流程/领域模型）
+7. **测试设计**: 使用 `06-test-design.md`
+8. **AI 评测**: 使用 `07-evaluation-design.md`
+9. **组件知识**: 使用 `08-component-knowledge.md`
+10. **最佳实践**: 使用 `09-best-practices.md`
+11. **中间件知识**: 使用 `10-middleware-knowledge.md`
+
+---
+
+## 与相关文档的关系
+
+| 文档 | 说明 |
+|------|------|
+| [../02-process/02-design.md](../02-process/02-design.md) | 方案设计阶段 |
+| [../03-guides/03-design-solution.md](../03-guides/03-design-solution.md) | 设计技能 |
+| [../04-checklists/02-design.md](../04-checklists/02-design.md) | 设计检查清单 |
+
+---
+
+**维护者**: AutoSpec 团队
+**进化分区**: 🟡 受控区
+**版本**: v3.0
+**最后更新**: 2026-03-29