@chongyan/autospec 1.0.2 → 1.0.3

package/knowledge/07-standards/03-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"等命名
-
-### 变更记录建议
-
-- 每次变更只做一件事
-- 变更说明简洁明了
-- 重大变更单独记录
-
-### 文档关联建议
-
-- 明确标注上下游关系
-- 定期检查关联一致性
-- 变更时同步更新关联文档
-
----
-
-**维护者**: 项目团队
-**关联文档**: `principles/04-evolution-mechanism.md`, `03-guides/14-check-consistency.md`

package/knowledge/07-standards/04-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/04-checklists/00-requirement.md` |
-| 方案设计 | `knowledge/04-checklists/01-design.md` |
-| 编码实现 | `knowledge/04-checklists/02-code.md` |
-| 交付部署 | `knowledge/04-checklists/04-release.md` |
-
-## 风险等级定义
-
-| 等级 | 定义 | 处理要求 |
-|------|------|---------|
-| **紧急** | 可能导致系统不可用或重大损失 | 必须立即解决，阻塞发布 |
-| **高** | 可能影响核心功能或用户体验 | 发布前必须解决 |
-| **中** | 可能影响非核心功能 | 发布前评估，可接受后发布 |
-| **低** | 影响有限，有兜底方案 | 记录并跟踪，后续优化 |
-
-## 风险缓解措施模板
-
-### 预防性措施
-
-```markdown
-| 措施ID | 措施名称 | 针对风险 | 实施方式 | 实施时机 |
-|--------|---------|---------|---------|---------|
-| PM-01 | （措施名） | （风险ID） | （如何实施） | （何时实施） |
-```
-
-### 应急性措施
-
-```markdown
-| 措施ID | 措施名称 | 针对风险 | 触发条件 | 执行步骤 |
-|--------|---------|---------|---------|---------|
-| EM-01 | （措施名） | （风险ID） | （何时触发） | （如何执行） |
-```
-
-## 版本历史
-
-| 版本 | 日期 | 修改人 | 修改说明 |
-|-----|------|--------|---------|
-| v1.0 | YYYY-MM-DD | | 初始版本 |
-
----
-
-**维护者**: 项目团队
-**关联文档**: `knowledge/04-checklists/04-release.md`, `knowledge/09-templates/06-business-rules.md`

package/knowledge/07-standards/README.en.md

@@ -1,119 +0,0 @@
-# Standards
-
-> **Purpose**: Standards for coding, review, data consistency, etc.
->
-> **Evolution Zone**: 🟡 Controlled (Auto-proposed + Human-approved)
-
----
-
-## Directory Structure
-
-```
-07-standards/
-├── README.md                     # This file (Standards Navigation)
-├── 00-coding-style.md            # Coding Style Guide
-├── 01-code-review.md             # Code Review Standard
-├── 02-data-consistency.md        # Data Consistency Standard
-├── 03-document-versioning.md     # Document Versioning Standard
-└── 04-risk-detection.md          # Risk Detection Standard
-```
-
----
-
-## Standards Description
-
-### 00-coding-style.md — Coding Style Guide
-
-**Content**: General coding standards, covering data safety, exception handling, multi-threading, database operations, etc.
-
-**Core Chapters**:
-- Reuse First & No Hardcoding
-- Data Safety (Lock-Check-Update)
-- Exception Handling
-- Multi-threading
-- Database Operations
-- Internationalization
-- Security
-- Logging Standards
-- Monitoring Standards
-- Coding Basics
-- Naming Conventions
-- SOLID Principles
-
-**Location**: [00-coding-style.md](00-coding-style.md)
-
-### 01-code-review.md — Code Review Standard
-
-**Content**: Standards and processes for code review
-
-**Core Chapters**:
-- Review Process
-- Review Dimensions (Architecture/Security/Performance/Maintainability/Logic)
-- Review Comment Format
-- Review Pass Criteria
-- AI-Enhanced Code Review
-
-**Location**: [01-code-review.md](01-code-review.md)
-
-### 02-data-consistency.md — Data Consistency Standard
-
-**Content**: Standards and best practices for data consistency guarantees
-
-**Core Chapters**:
-- Distributed Transactions
-- Eventual Consistency
-- Data Synchronization
-- Idempotency Design
-
-**Location**: [02-data-consistency.md](02-data-consistency.md)
-
-### 03-document-versioning.md — Document Versioning Standard
-
-**Content**: Standards for document version management
-
-**Core Chapters**:
-- Version Number Rules
-- Version History
-- Change Marking
-
-**Location**: [03-document-versioning.md](03-document-versioning.md)
-
-### 04-risk-detection.md — Risk Detection Standard
-
-**Content**: Standards and processes for risk detection
-
-**Core Chapters**:
-- Risk Type Identification
-- Risk Level Assessment
-- Risk Handling Process
-
-**Location**: [04-risk-detection.md](04-risk-detection.md)
-
----
-
-## Usage
-
-Standards are applied in the following scenarios:
-
-1. **Implementation**: Follow `00-coding-style.md`
-2. **Code Review**: Follow `01-code-review.md`
-3. **Solution Design**: Follow `02-data-consistency.md` for data consistency requirements
-4. **Documentation**: Follow `03-document-versioning.md` for versioning standards
-5. **Risk Assessment**: Follow `04-risk-detection.md` for detection standards
-
----
-
-## Related Documents
-
-| Document | Description |
-|----------|-------------|
-| [../04-checklists/](../04-checklists/) | Checklists (Based on standards) |
-| [../03-guides/04-implement-code.md](../03-guides/04-implement-code.md) | Implementation Skills |
-| [../03-guides/11-review-code.md](../03-guides/11-review-code.md) | Code Review Skills |
-
----
-
-**Maintainer**: AutoSpec Team
-**Evolution Zone**: 🟡 Controlled
-**Version**: v1.0
-**Last Updated**: 2026-03-27

package/knowledge/07-standards/README.md

@@ -1,123 +0,0 @@
-# 标准规范
-
-> **定位**: 编码、审查、数据一致性等标准规范
->
-> **进化分区**: 🟡 受控区（自动提议 + 人工批准）
-
----
-
-## 目录结构
-
-```
-07-standards/
-├── README.md                     # 本文件（标准规范导航）
-├── 00-coding-style.md            # 编码规范
-├── 01-code-review.md             # 代码审查规范
-├── 02-data-consistency.md        # 数据一致性规范
-├── 03-document-versioning.md     # 文档版本化规范
-└── 04-risk-detection.md          # 风险检测规范
-```
-
----
-
-## 规范说明
-
-### 00-coding-style.md — 编码规范
-
-**内容**: 通用编码规范，覆盖数据安全、异常处理、多线程、数据库等
-
-**核心章节**:
-- 复用优先与禁止硬编码
-- 数据安全（一锁二判三更新）
-- 异常处理
-- 多线程
-- 数据库操作
-- 国际化
-- 安全
-- 日志打印
-- 监控规范
-- 编码基础
-- 命名规范
-- 面向对象设计原则（SOLID）
-
-**位置**: [00-coding-style.md](00-coding-style.md)
-
-### 01-code-review.md — 代码审查规范
-
-**内容**: 代码审查的标准和流程
-
-**核心章节**:
-- 审查流程
-- 审查维度（架构/安全/性能/可维护性/逻辑）
-- 审查意见格式
-- 审查通过标准
-- AI 增强 Code Review
-
-**位置**: [01-code-review.md](01-code-review.md)
-
-### 02-data-consistency.md — 数据一致性规范
-
-**内容**: 数据一致性保障的标准和最佳实践
-
-**核心章节**:
-- 分布式事务
-- 最终一致性
-- 数据同步
-- 幂等性设计
-
-**位置**: [02-data-consistency.md](02-data-consistency.md)
-
-### 03-document-versioning.md — 文档版本化规范
-
-**内容**: 文档版本管理的标准
-
-**核心章节**:
-- 版本号规则
-- 版本历史
-- 变更标记
-
-**位置**: [03-document-versioning.md](03-document-versioning.md)
-
-### 04-risk-detection.md — 风险检测规范
-
-**内容**: 风险检测的标准和流程
-
-**核心章节**:
-- 风险类型识别
-- 风险等级评估
-- 风险处理流程
-
-**位置**: [04-risk-detection.md](04-risk-detection.md)
-
----
-
-## 使用方式
-
-标准规范在以下场景应用：
-
-1. **编码实现**: 遵循 `00-coding-style.md`
-2. **代码审查**: 遵循 `01-code-review.md`
-3. **方案设计**: 遵循 `02-data-consistency.md` 数据一致性要求
-4. **文档编写**: 遵循 `03-document-versioning.md` 版本化规范
-5. **风险评估**: 遵循 `04-risk-detection.md` 检测规范
-
----
-
-## 与相关文档的关系
-
-| 文档 | 说明 |
-|------|------|
-| [../04-checklists/](../04-checklists/) | 检查清单（基于标准规范） |
-| [../03-guides/04-implement-code.md](../03-guides/04-implement-code.md) | 编码实现技能 |
-| [../03-guides/11-review-code.md](../03-guides/11-review-code.md) | 代码审查技能 |
-
----
-
-**维护者**: AutoSpec 团队
-**进化分区**: 🟡 受控区
-**版本**: v1.1
-**最后更新**: 2026-03-28
-
----
-
-⬆️ [返回知识层目录](../README.md) · 📐 [标准规范总览](#)