@chongyan/autospec 1.0.1 → 1.0.3

package/knowledge/standards/document-versioning.md

@@ -1,210 +0,0 @@
-# 文档版本化管理规范
-
-> 统一所有产出物的版本化标准。
-
-## 版本号规则
-
-### 主文档版本
-
-- 格式：`v{MAJOR}.{MINOR}`
-- MAJOR：需求方向/架构重大变更
-- MINOR：功能增减/细节调整
-
-### 版本变更判定
-
-| 变更类型 | 版本变更 | 示例 |
-|---------|---------|------|
-| 初始创建 | v1.0 | 首次产出文档 |
-| 新增章节/字段 | v1.0 → v1.1 | 新增风险评估章节 |
-| 修改内容 | v1.0 → v1.1 | 调整功能描述 |
-| 删除内容 | v1.0 → v1.1 | 移除废弃功能 |
-| 需求方向变更 | v1.0 → v2.0 | 核心功能重新定义 |
-| 架构重构 | v1.0 → v2.0 | 技术方案重大调整 |
-
-## 文档头部模板
-
-每个产出物文档必须包含以下头部：
-
-```markdown
----
-document_id: {TYPE}-{feature}-{NN}
-version: v1.0
-created: YYYY-MM-DD
-updated: YYYY-MM-DD
-status: Draft/Review/Approved/Archived
-author: AI/Human
-upstream: [关联文档ID列表]
-downstream: [下游文档ID列表]
----
-
-# 文档标题
-```
-
-### 文档ID格式
-
-| 文档类型 | ID前缀 | 示例 |
-|---------|--------|------|
-| 需求文档 | REQ | REQ-order-001 |
-| 设计文档 | DES | DES-order-001 |
-| 风险文档 | RISK | RISK-order-001 |
-| 测试报告 | TEST | TEST-order-001 |
-| 业务规则 | BR | BR-01 |
-
-### 状态定义
-
-| 状态 | 说明 |
-|------|------|
-| Draft | 草稿，正在编写中 |
-| Review | 待评审，已完成编写 |
-| Approved | 已评审通过 |
-| Archived | 已归档，不再更新 |
-
-## 更新说明记录
-
-每次文档更新必须记录：
-
-```markdown
-## 版本历史
-
-| 版本 | 日期 | 修改人 | 修改说明 |
-|-----|------|--------|---------|
-| v1.1 | YYYY-MM-DD | XXX | 新增风险评估章节 |
-| v1.0 | YYYY-MM-DD | XXX | 初始版本 |
-```
-
-### 更新说明规范
-
-| 字段 | 内容 |
-|-----|------|
-| 更新版本 | v1.1 |
-| 更新日期 | YYYY-MM-DD |
-| 更新类型 | 新增/修改/删除 |
-| 更新位置 | 章节/段落 |
-| 更改原因 | 为什么改 |
-| 影响分析 | 影响哪些下游文档/代码 |
-
-## 跨产物一致性
-
-### 文档关联关系
-
-```
-requirement.md (REQ-001)
-    ├── upstream: []
-    └── downstream: [DES-001]
-
-design.md (DES-001)
-    ├── upstream: [REQ-001]
-    └── downstream: [TEST-001]
-
-test-report.md (TEST-001)
-    ├── upstream: [DES-001]
-    └── downstream: []
-```
-
-### 一致性检查
-
-当一份文档更新时：
-
-1. **识别关联文档**：通过 upstream/downstream 字段
-2. **评估影响范围**：判断是否需要更新关联文档
-3. **更新关联文档**：同步更新或记录不一致
-4. **触发一致性检查**：使用 consistency-checker 重新检查
-
-### 不一致处理
-
-```markdown
-## 待同步项
-
-| 文档ID | 不一致内容 | 处理状态 | 处理人 |
-|--------|----------|---------|--------|
-| DES-001 | 需求变更后设计未更新 | 待处理 | XXX |
-```
-
-## 与进化机制的关系
-
-### 进化分区映射
-
-| 文档类型 | 进化分区 | 变更方式 |
-|---------|---------|---------|
-| requirement.md | 自由区 | 自动提取 + 人工确认 |
-| design.md | 受控区 | 自动提议 + 人工审批 |
-| rules.md | 受控区 | 从 practice-log 提取 |
-| glossary.md | 自由区 | 自动提取 + 人工确认 |
-
-### practice-log 记录
-
-文档版本变更自动记录到 practice-log：
-
-```markdown
-## 文档变更记录
-
-| 时间 | 文档 | 版本变更 | 变更类型 | 触发来源 |
-|-----|------|---------|---------|---------|
-| 2024-01-15 | REQ-order-001 | v1.0 → v1.1 | 需求澄清 | 用户反馈 |
-```
-
-## 版本回溯
-
-### 查看历史版本
-
-```bash
-# Git 历史查看
-git log --follow -- path/to/document.md
-
-# 特定版本查看
-git show COMMIT_HASH:path/to/document.md
-```
-
-### 版本对比
-
-```bash
-# 版本间对比
-git diff COMMIT_OLD COMMIT_NEW -- path/to/document.md
-```
-
-## 模板版本化
-
-### 模板文件版本
-
-模板文件本身也需要版本化：
-
-```markdown
----
-template_id: TPL-requirement-001
-template_version: v1.0
-template_updated: YYYY-MM-DD
----
-```
-
-### 模板变更通知
-
-模板变更时需要：
-1. 更新模板版本号
-2. 记录变更内容
-3. 通知使用该模板的文档作者
-4. 评估是否需要更新现有文档
-
-## 最佳实践
-
-### 版本命名建议
-
-- 使用语义化版本号
-- 保持版本号简洁（最多两位）
-- 避免使用"最新"、"final"等命名
-
-### 变更记录建议
-
-- 每次变更只做一件事
-- 变更说明简洁明了
-- 重大变更单独记录
-
-### 文档关联建议
-
-- 明确标注上下游关系
-- 定期检查关联一致性
-- 变更时同步更新关联文档
-
----
-
-**维护者**: 项目团队
-**关联文档**: `knowledge/principles/evolution.md`, `knowledge/guides/support/consistency-checker.md`

package/knowledge/standards/risk-detection.md

@@ -1,186 +0,0 @@
-# 风险与检测文档模板
-
-> 在各阶段识别风险并制定检测方案。
-
-## 使用场景
-
-| 阶段 | 使用方式 |
-|------|---------|
-| 需求分析 | 识别业务风险，定义检测指标 |
-| 方案设计 | 识别技术风险，设计应对方案 |
-| 交付部署 | 识别运维风险，制定应急预案 |
-
-## 风险分类
-
-### 业务风险
-
-业务逻辑、用户体验相关的风险：
-
-| 风险类型 | 示例 |
-|---------|------|
-| 数据不一致 | 并发操作导致数据状态冲突 |
-| 业务流程中断 | 异常场景未处理导致流程卡住 |
-| 用户体验下降 | 响应慢、操作复杂、提示不清晰 |
-| 业务规则违反 | 代码未正确实现业务约束 |
-
-### 技术风险
-
-技术实现、系统稳定性相关的风险：
-
-| 风险类型 | 示例 |
-|---------|------|
-| 性能瓶颈 | 大数据量下查询慢、内存溢出 |
-| 可用性风险 | 单点故障、依赖服务不可用 |
-| 安全漏洞 | 注入攻击、权限绕过、数据泄露 |
-| 兼容性问题 | 版本升级、浏览器兼容、接口变更 |
-
-### 运维风险
-
-部署、监控、应急相关的风险：
-
-| 风险类型 | 示例 |
-|---------|------|
-| 发布失败 | 部署脚本错误、配置遗漏 |
-| 回滚困难 | 数据迁移不可逆、依赖变更 |
-| 监控盲区 | 关键指标未监控、告警阈值不合理 |
-| 应急响应慢 | 无预案、预案未演练 |
-
-## 模板格式
-
-### 文档头部
-
-```markdown
----
-document_id: RISK-{feature}-001
-version: v1.0
-created: YYYY-MM-DD
-updated: YYYY-MM-DD
-upstream: [REQ-{feature}-001, DES-{feature}-001]
----
-
-# {功能名称}风险与检测
-
-## 文档信息
-- 版本：v1.0
-- 创建日期：YYYY-MM-DD
-- 关联需求：requirement.md
-- 关联设计：design.md
-```
-
-### 风险登记表
-
-```markdown
-## 风险登记表
-
-### 业务风险
-
-| ID | 名称 | 描述 | 可能性 | 影响 | 缓解措施 | 检测方式 |
-|----|------|------|--------|------|---------|---------|
-| BR-01 | （风险名） | （详细描述） | 高/中/低 | 高/中/低 | （如何缓解） | （如何检测） |
-
-### 技术风险
-
-| ID | 名称 | 描述 | 可能性 | 影响 | 缓解措施 | 检测方式 |
-|----|------|------|--------|------|---------|---------|
-| TR-01 | （风险名） | （详细描述） | 高/中/低 | 高/中/低 | （如何缓解） | （如何检测） |
-
-### 运维风险
-
-| ID | 名称 | 描述 | 可能性 | 影响 | 缓解措施 | 检测方式 |
-|----|------|------|--------|------|---------|---------|
-| OR-01 | （风险名） | （详细描述） | 高/中/低 | 高/中/低 | （如何缓解） | （如何检测） |
-```
-
-### 风险矩阵
-
-可视化展示风险优先级：
-
-```markdown
-## 风险矩阵
-
-|  | 低影响 | 中影响 | 高影响 |
-|--|--------|--------|--------|
-| **高可能性** | 中优先级 | 高优先级 | **紧急** |
-| **中可能性** | 低优先级 | 中优先级 | 高优先级 |
-| **低可能性** | 可接受 | 低优先级 | 中优先级 |
-
-### 当前风险分布
-
-- 紧急风险：{数量}个
-- 高优先级：{数量}个
-- 中优先级：{数量}个
-- 低优先级：{数量}个
-```
-
-### 检测计划
-
-```markdown
-## 检测计划
-
-| 风险ID | 检测方式 | 执行时机 | 负责人 | 预期结果 | 状态 |
-|--------|---------|---------|--------|---------|------|
-| BR-01 | （方式） | （时机） | （谁） | （期望） | 待执行/已通过/未通过 |
-```
-
-### 检测方式说明
-
-| 检测方式 | 说明 | 适用场景 |
-|---------|------|---------|
-| 单元测试 | 自动化测试验证 | 代码逻辑风险 |
-| 集成测试 | 多模块联调验证 | 接口交互风险 |
-| 压力测试 | 高并发场景验证 | 性能风险 |
-| 安全扫描 | 自动化安全检测 | 安全漏洞风险 |
-| 代码审查 | 人工代码Review | 设计缺陷风险 |
-| 预发验证 | 预发环境端到端测试 | 业务流程风险 |
-| 监控告警 | 线上实时监控 | 运维风险 |
-
-## 与阶段检查清单的关系
-
-```
-风险识别 → 检测计划制定 → 检测项加入检查清单 → 阶段执行时验证
-```
-
-| 阶段 | 检查清单引用 |
-|------|-------------|
-| 需求分析 | `knowledge/checklists/requirement.md` |
-| 方案设计 | `knowledge/checklists/design.md` |
-| 编码实现 | `knowledge/checklists/code.md` |
-| 交付部署 | `knowledge/checklists/release.md` |
-
-## 风险等级定义
-
-| 等级 | 定义 | 处理要求 |
-|------|------|---------|
-| **紧急** | 可能导致系统不可用或重大损失 | 必须立即解决，阻塞发布 |
-| **高** | 可能影响核心功能或用户体验 | 发布前必须解决 |
-| **中** | 可能影响非核心功能 | 发布前评估，可接受后发布 |
-| **低** | 影响有限，有兜底方案 | 记录并跟踪，后续优化 |
-
-## 风险缓解措施模板
-
-### 预防性措施
-
-```markdown
-| 措施ID | 措施名称 | 针对风险 | 实施方式 | 实施时机 |
-|--------|---------|---------|---------|---------|
-| PM-01 | （措施名） | （风险ID） | （如何实施） | （何时实施） |
-```
-
-### 应急性措施
-
-```markdown
-| 措施ID | 措施名称 | 针对风险 | 触发条件 | 执行步骤 |
-|--------|---------|---------|---------|---------|
-| EM-01 | （措施名） | （风险ID） | （何时触发） | （如何执行） |
-```
-
-## 版本历史
-
-| 版本 | 日期 | 修改人 | 修改说明 |
-|-----|------|--------|---------|
-| v1.0 | YYYY-MM-DD | | 初始版本 |
-
----
-
-**维护者**: 项目团队
-**关联文档**: `knowledge/checklists/release.md`, `knowledge/domain/rules.md`

package/knowledge/templates/ai-evaluation.md

@@ -1,150 +0,0 @@
-# AI 评测设计模板
-
-> 规范化 AI/模型功能评测文档，确保效果可量化、可追溯。
-
-## 使用说明
-
-1. 每个 AI 功能或模型使用独立的 .md 文件
-2. 文件命名：`{功能名}-evaluation.md`，如 `chat-bot-evaluation.md`
-3. 评测结果需记录到版本历史
-
-## 评测概述
-
-| 字段 | 值 |
-|------|-----|
-| 功能名称 | {功能名} |
-| 模型版本 | {version} |
-| 评测日期 | YYYY-MM-DD |
-| 评测人 | {name} |
-
-## 评测目标
-
-| 目标 | 描述 | 目标值 |
-|------|------|-------|
-| {目标1} | {描述} | {目标值} |
-| {目标2} | {描述} | {目标值} |
-
-## 评测指标
-
-| 指标名称 | 计算方式 | 权重 | 说明 |
-|---------|---------|------|------|
-| 准确率 Accuracy | 正确数/总数 | 30% | 分类正确率 |
-| 召回率 Recall | TP/(TP+FN) | 20% | 正例召回率 |
-| 精确率 Precision | TP/(TP+FP) | 20% | 预测正确率 |
-| F1 Score | 2*P*R/(P+R) | 20% | 综合指标 |
-| 响应时间 | 平均延迟 | 10% | 性能指标 |
-
-## 评测数据集
-
-### 数据集概述
-
-| 字段 | 值 |
-|------|-----|
-| 数据集名称 | {dataset_name} |
-| 数据量 | {count} |
-| 数据来源 | {source} |
-| 标注方式 | 人工标注/自动标注 |
-| 更新日期 | YYYY-MM-DD |
-
-### 数据分布
-
-| 类别 | 数量 | 占比 |
-|------|------|------|
-| {类别1} | {count} | {percent}% |
-| {类别2} | {count} | {percent}% |
-
-### 数据样例
-
-```json
-{
-  "id": "sample_001",
-  "input": "用户输入内容",
-  "expected_output": "期望输出",
-  "category": "类别",
-  "difficulty": "easy/medium/hard"
-}
-```
-
-## 评测方法
-
-### 评测流程
-
-```mermaid
-flowchart TD
-    A[加载数据集] --> B[模型推理]
-    B --> C[结果收集]
-    C --> D[指标计算]
-    D --> E[Badcase 分析]
-    E --> F[生成报告]
-```
-
-### 评测脚本
-
-```python
-# 评测脚本示例
-def evaluate(model, dataset):
-    results = []
-    for sample in dataset:
-        prediction = model.predict(sample['input'])
-        results.append({
-            'id': sample['id'],
-            'expected': sample['expected_output'],
-            'actual': prediction,
-            'correct': prediction == sample['expected_output']
-        })
-    return calculate_metrics(results)
-```
-
-## 评测结果
-
-### 整体指标
-
-| 指标 | 目标值 | 实际值 | 是否达标 |
-|------|-------|-------|---------|
-| Accuracy | {target} | {actual} | ✅/❌ |
-| Recall | {target} | {actual} | ✅/❌ |
-| Precision | {target} | {actual} | ✅/❌ |
-| F1 Score | {target} | {actual} | ✅/❌ |
-| 响应时间 | {target}ms | {actual}ms | ✅/❌ |
-
-### 分类指标
-
-| 类别 | 样本数 | 准确率 | 召回率 | F1 |
-|------|-------|-------|-------|-----|
-| {类别1} | {count} | {acc} | {recall} | {f1} |
-| {类别2} | {count} | {acc} | {recall} | {f1} |
-
-## Badcase 分析
-
-### Badcase 列表
-
-| ID | 输入 | 期望 | 实际 | 原因分析 | 改进建议 |
-|-----|------|------|------|---------|---------|
-| 001 | {input} | {expected} | {actual} | {reason} | {suggestion} |
-
-### 错误类型分布
-
-| 错误类型 | 数量 | 占比 | 典型案例 |
-|---------|------|------|---------|
-| 理解错误 | {count} | {percent}% | {example} |
-| 知识缺失 | {count} | {percent}% | {example} |
-| 推理错误 | {count} | {percent}% | {example} |
-
-## 改进计划
-
-| 优先级 | 改进项 | 预期效果 | 负责人 | 截止日期 |
-|-------|-------|---------|-------|---------|
-| P0 | {改进项} | {效果} | {name} | {date} |
-| P1 | {改进项} | {效果} | {name} | {date} |
-
-## 版本历史
-
-| 版本 | 日期 | 修改人 | 修改说明 |
-|-----|------|--------|---------|
-| v1.0 | YYYY-MM-DD | | 初始版本 |
-
----
-
-**维护者**: AI 团队
-**进化分区**: 自由区
-**关联文档**: `test-knowledge/test-designs/{name}.md`

package/knowledge/templates/api-design.md

@@ -1,117 +0,0 @@
-# API 设计模板
-
-> 规范化接口设计文档，确保接口契约清晰、一致。
-
-## 使用说明
-
-1. 每个接口或接口组使用独立的 .md 文件
-2. 文件命名：`{服务名}-{模块名}.md`，如 `order-service.md`
-3. 接口变更需更新版本历史
-
-## 接口概述
-
-| 字段 | 值 |
-|------|-----|
-| 服务名称 | {服务名} |
-| 基础路径 | `/api/v1/{module}` |
-| 认证方式 | Bearer Token / API Key / OAuth 2.0 |
-| 版本 | v1.0 |
-
-## 接口列表
-
-| 接口名称 | HTTP方法 | 路径 | 描述 |
-|---------|---------|------|------|
-| {接口1} | GET/POST/PUT/DELETE | `/{resource}` | {描述} |
-| {接口2} | GET/POST/PUT/DELETE | `/{resource}/{id}` | {描述} |
-
-## 接口详情
-
-### {接口名称}
-
-**请求**
-
-```http
-{METHOD} /api/v1/{path} HTTP/1.1
-Content-Type: application/json
-Authorization: Bearer {token}
-```
-
-**请求参数**
-
-| 参数名 | 类型 | 必填 | 位置 | 描述 | 示例 |
-|-------|------|------|------|------|------|
-| {param} | string/number/boolean | 是/否 | path/query/body | {描述} | {示例} |
-
-**请求体**
-
-```json
-{
-  "field1": "value1",
-  "field2": 123
-}
-```
-
-**响应体**
-
-```json
-{
-  "code": 0,
-  "message": "success",
-  "data": {
-    "id": "xxx",
-    "name": "xxx"
-  }
-}
-```
-
-## 错误码定义
-
-| 错误码 | HTTP状态码 | 描述 | 处理建议 |
-|-------|-----------|------|---------|
-| 0 | 200 | 成功 | - |
-| 1001 | 400 | 参数错误 | 检查请求参数 |
-| 1002 | 401 | 未授权 | 检查认证信息 |
-| 1003 | 403 | 禁止访问 | 检查权限 |
-| 1004 | 404 | 资源不存在 | 检查资源ID |
-| 1005 | 500 | 服务器错误 | 联系管理员 |
-
-## 通用规范
-
-### 请求头
-
-| 头字段 | 必填 | 描述 |
-|-------|------|------|
-| Content-Type | 是 | application/json |
-| Authorization | 是 | Bearer {token} |
-| X-Request-ID | 否 | 请求追踪ID |
-
-### 响应格式
-
-```json
-{
-  "code": 0,
-  "message": "success",
-  "data": {},
-  "traceId": "xxx"
-}
-```
-
-### 分页参数
-
-| 参数名 | 类型 | 默认值 | 描述 |
-|-------|------|-------|------|
-| page | number | 1 | 页码 |
-| pageSize | number | 20 | 每页数量 |
-| total | number | - | 总数量（响应中返回） |
-
-## 版本历史
-
-| 版本 | 日期 | 修改人 | 修改说明 |
-|-----|------|--------|---------|
-| v1.0 | YYYY-MM-DD | | 初始版本 |
-
----
-
-**维护者**: 后端团队
-**进化分区**: 受控区
-**关联文档**: `design-knowledge/architecture/{name}.md`