@chongyan/autospec 1.0.2 → 1.0.4

package/knowledge/09-templates/10-middleware-knowledge.md

@@ -1,342 +0,0 @@
-# 中间件知识模板
-
-> 本模板定义中间件知识的标准格式。供 env-sync 生成知识文件时参考。
-
----
-
-## 文件位置
-
-`.autospec/environment/env-knowledge/middleware/{name}.md`
-
----
-
-## 基本信息
-
-| 字段 | 必填 | 说明 |
-|------|------|------|
-| 名称 | 是 | 中间件名称，如 mysql、redis |
-| 类型 | 是 | 参见类型枚举 |
-| 默认端口 | 否 | 默认端口号 |
-| 知识版本 | 是 | 格式 v1.0 |
-| 维护者 | 否 | 维护团队或个人 |
-
-### 类型枚举
-
-| 类型 | 说明 |
-|------|------|
-| relational-database | 关系型数据库 |
-| document-database | 文档数据库 |
-| cache | 缓存 |
-| message-queue | 消息队列 |
-| search-engine | 搜索引擎 |
-| vector-store | 向量存储 |
-| object-storage | 对象存储 |
-| llm | 大语言模型服务 |
-| messaging | 消息服务 |
-| storage | 存储服务 |
-| payment | 支付服务 |
-| auth | 认证服务 |
-| notification | 通知服务 |
-| external-api | 外部 API 服务 |
-
----
-
-## 环境变量
-
-### 必需变量
-
-| 变量名 | 说明 | 示例 |
-|--------|------|------|
-| {NAME}_HOST | 主机地址 | db.example.com |
-| {NAME}_DATABASE | 数据库名称 | myapp_db |
-| {NAME}_USER | 用户名 | app_user |
-| {NAME}_PASSWORD | 密码 | - |
-
-### 可选变量
-
-| 变量名 | 默认值 | 说明 |
-|--------|--------|------|
-| {NAME}_PORT | 默认端口 | 端口号 |
-| {NAME}_POOL_SIZE | 10 | 连接池大小 |
-| {NAME}_TIMEOUT | 5000 | 超时时间(ms) |
-
----
-
-## 连接代码模板
-
-按语言分节，提供连接代码示例。
-
-### Node.js
-
-```javascript
-// 连接代码示例
-const client = new Client({
-  host: process.env.{NAME}_HOST,
-  port: process.env.{NAME}_PORT || {默认端口},
-  database: process.env.{NAME}_DATABASE,
-  user: process.env.{NAME}_USER,
-  password: process.env.{NAME}_PASSWORD,
-});
-```
-
-### Python
-
-```python
-# 连接代码示例
-import os
-client = Client(
-    host=os.environ['{NAME}_HOST'],
-    port=int(os.environ.get('{NAME}_PORT', {默认端口})),
-    database=os.environ['{NAME}_DATABASE'],
-    user=os.environ['{NAME}_USER'],
-    password=os.environ['{NAME}_PASSWORD'],
-)
-```
-
-### Java
-
-```java
-// 连接代码示例
-Client client = Client.builder()
-    .host(System.getenv("{NAME}_HOST"))
-    .port(Integer.parseInt(System.getenv().getOrDefault("{NAME}_PORT", "{默认端口}")))
-    .database(System.getenv("{NAME}_DATABASE"))
-    .user(System.getenv("{NAME}_USER"))
-    .password(System.getenv("{NAME}_PASSWORD"))
-    .build();
-```
-
----
-
-## 接口定义（外部服务专用）
-
-> 本章节仅适用于 external-api、llm、auth、payment、notification 等外部服务类型。
-
-### Facade 接口
-
-```java
-// 接口定义
-public interface XxxFacade {
-    Result method(Request request);
-}
-```
-
-### 主要方法
-
-| 方法名 | 参数 | 返回值 | 说明 |
-|--------|------|--------|------|
-| {method} | {params} | {return} | {description} |
-
-### 服务端点配置
-
-| 配置项 | 说明 | 示例 |
-|--------|------|------|
-| {SERVICE}_ENDPOINT | 服务地址 | https://api.example.com |
-| {SERVICE}_TIMEOUT | 超时时间(ms) | 5000 |
-
----
-
-## 最佳实践
-
-1. 使用连接池管理连接，避免每次请求创建新连接
-2. 设置合理的超时时间，避免连接泄漏
-3. 敏感信息使用环境变量，不要硬编码
-4. 实现重试机制，处理临时网络故障
-5. 记录连接日志，便于问题排查
-
----
-
-## 反模式清单
-
-| 反模式 | 风险 | 替代方案 |
-|--------|------|----------|
-| 直接拼接SQL字符串 | SQL注入风险 | 使用参数化查询 |
-| 在代码中硬编码密码 | 安全风险 | 使用环境变量或密钥管理服务 |
-| 不设置超时时间 | 连接泄漏 | 设置合理的连接和查询超时 |
-| 每次请求创建新连接 | 性能问题 | 使用连接池 |
-| 忽略错误处理 | 系统不稳定 | 实现完善的错误处理和重试机制 |
-
----
-
-## 健康检查
-
-```bash
-# 健康检查命令示例
-{CLI_TOOL} ping -h ${NAME}_HOST -u ${NAME}_USER -p${NAME}_PASSWORD
-```
-
----
-
-## 依赖信息
-
-### Maven 依赖
-
-| GroupId | ArtifactId | 版本 | 说明 |
-|---------|-----------|------|------|
-| {group} | {artifact} | {version} | {description} |
-
-### npm 依赖
-
-| 包名 | 版本 | 说明 |
-|------|------|------|
-| {package} | {version} | {description} |
-
-### pip 依赖
-
-| 包名 | 版本 | 说明 |
-|------|------|------|
-| {package} | {version} | {description} |
-
----
-
-## 配置项详解
-
-| 配置项 | 类型 | 必填 | 默认值 | 说明 |
-|--------|------|------|--------|------|
-| {key} | {type} | 是/否 | {default} | {description} |
-
-### 配置示例
-
-```properties
-# application.properties
-{name}.host=${NAME}_HOST
-{name}.port=${NAME}_PORT
-{name}.database=${NAME}_DATABASE
-```
-
-```yaml
-# application.yml
-{name}:
-  host: ${NAME_HOST}
-  port: ${NAME_PORT}
-  database: ${NAME_DATABASE}
-```
-
----
-
-## 实际使用代码
-
-### 项目中的使用示例
-
-**来源**: `{file_path}:{line_number}`
-
-```java
-// 实际项目代码示例
-{actual_code_snippet}
-```
-
-### 客户端类
-
-| 类名 | 路径 | 说明 |
-|------|------|------|
-| {ClientClass} | {path} | 客户端实现 |
-| {ConfigClass} | {path} | 配置类 |
-
----
-
-## 示例：MySQL 中间件知识
-
-```markdown
-# MySQL 中间件知识
-
-## 基本信息
-
-| 字段 | 值 |
-|------|-----|
-| 名称 | mysql |
-| 类型 | relational-database |
-| 默认端口 | 3306 |
-| 知识版本 | v1.0 |
-
-## 环境变量
-
-### 必需变量
-
-| 变量名 | 说明 | 示例 |
-|--------|------|------|
-| MYSQL_HOST | 数据库主机地址 | db.example.com |
-| MYSQL_DATABASE | 数据库名称 | myapp_db |
-| MYSQL_USER | 用户名 | app_user |
-| MYSQL_PASSWORD | 密码 | - |
-
-### 可选变量
-
-| 变量名 | 默认值 | 说明 |
-|--------|--------|------|
-| MYSQL_PORT | 3306 | 数据库端口 |
-| MYSQL_POOL_SIZE | 10 | 连接池大小 |
-
-## 连接代码模板
-
-### Node.js
-
-```javascript
-const mysql = require('mysql2/promise');
-const pool = mysql.createPool({
-  host: process.env.MYSQL_HOST,
-  port: process.env.MYSQL_PORT || 3306,
-  database: process.env.MYSQL_DATABASE,
-  user: process.env.MYSQL_USER,
-  password: process.env.MYSQL_PASSWORD,
-  waitForConnections: true,
-  connectionLimit: parseInt(process.env.MYSQL_POOL_SIZE || '10')
-});
-```
-
-### Python
-
-```python
-import pymysql
-from dbutils.pooled_db import PooledDB
-
-pool = PooledDB(
-    creator=pymysql,
-    host=os.environ['MYSQL_HOST'],
-    port=int(os.environ.get('MYSQL_PORT', 3306)),
-    database=os.environ['MYSQL_DATABASE'],
-    user=os.environ['MYSQL_USER'],
-    password=os.environ['MYSQL_PASSWORD'],
-    maxconnections=int(os.environ.get('MYSQL_POOL_SIZE', '10'))
-)
-```
-
-## 最佳实践
-
-1. 使用连接池，不要在每次请求时创建新连接
-2. 设置合理的超时时间，避免连接泄漏
-3. 敏感信息使用环境变量，不要硬编码
-
-## 反模式清单
-
-| 反模式 | 风险 | 替代方案 |
-|--------|------|----------|
-| 直接拼接SQL字符串 | SQL注入风险 | 使用参数化查询 |
-| 在代码中硬编码密码 | 安全风险 | 使用环境变量 |
-
-## 健康检查
-
-```bash
-mysqladmin ping -h ${MYSQL_HOST} -u ${MYSQL_USER} -p${MYSQL_PASSWORD}
-```
-```
-
----
-
-## 自检清单
-
-生成中间件知识文件后，检查以下项目：
-
-- [ ] 基本信息章节完整，包含名称、类型、知识版本
-- [ ] 环境变量章节包含必需变量和可选变量表格
-- [ ] 连接代码模板包含项目使用的主要语言
-- [ ] **依赖信息章节完整，包含 Maven/npm/pip 依赖**
-- [ ] **配置项详解章节包含配置项表格和示例**
-- [ ] **实际使用代码章节包含项目中的真实代码示例**
-- [ ] 最佳实践列表不为空
-- [ ] 反模式清单包含风险和替代方案
-
----
-
-**维护者**: AutoSpec 团队
-**进化分区**: 🟡 受控区
-**关联文档**: `knowledge/06-environment/00-template-registry.md`

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

@@ -1,222 +0,0 @@
-# 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