create-specification

创建规范

你的目标是为${input:SpecPurpose}创建一个新的规范文件。

规范文件必须以清晰、无歧义且结构化的方式定义解决方案组件的需求、约束和接口，以便生成式AI有效使用。遵循既定的文档标准，确保内容机器可读且自包含。

AI就绪规范的最佳实践

• 使用精确、明确且无歧义的语言。
• 清晰区分需求、约束和建议。
• 使用结构化格式（标题、列表、表格）以便于解析。
• 避免使用习语、隐喻或依赖上下文的引用。
• 定义所有缩写和领域特定术语。
• 在适用时包含示例和边界情况。
• 确保文档自包含，不依赖外部上下文。

规范应保存在/spec/目录中，并按照以下约定命名：spec-[a-z0-9-]+.md，其中名称应描述规范的内容，并以高级目的开头，高级目的为[schema, tool, data, infrastructure, process, architecture, or design]之一。

规范文件必须格式化为格式良好的Markdown。

规范文件必须遵循以下模板，确保所有部分都适当填写。Markdown的前置元数据应按照以下示例正确结构化：

---
title: [描述规范焦点的简洁标题]
version: [可选：例如 1.0, 日期]
date_created: [YYYY-MM-DD]
last_updated: [可选：YYYY-MM-DD]
owner: [可选：负责此规范的团队/个人]
tags: [可选：相关标签或类别列表，例如 `infrastructure`, `process`, `design`, `app` 等]
---

# 引言

[对规范及其目标进行简短简洁的介绍。]

## 1. 目的与范围

[清晰、简洁地描述规范的目的及其应用范围。说明目标受众和任何假设。]

## 2. 定义

[列出并定义本规范中使用的所有缩写、缩略语和领域特定术语。]

## 3. 需求、约束与指南

[明确列出所有需求、约束、规则和指南。使用项目符号或表格以提高清晰度。]

- **REQ-001**: 需求1
- **SEC-001**: 安全需求1
- **[3个字母]-001**: 其他需求1
- **CON-001**: 约束1
- **GUD-001**: 指南1
- **PAT-001**: 要遵循的模式1

## 4. 接口与数据契约

[描述接口、API、数据契约或集成点。使用表格或代码块展示模式和示例。]

## 5. 验收标准

[为每个需求定义清晰、可测试的验收标准，在适当时使用Given-When-Then格式。]

- **AC-001**: 给定[上下文]，当[动作]，则[预期结果]
- **AC-002**: 系统应在[条件]时[具体行为]
- **AC-003**: [根据需要添加其他验收标准]

## 6. 测试自动化策略

[定义测试方法、框架和自动化需求。]

- **测试级别**: 单元测试、集成测试、端到端测试
- **框架**: MSTest, FluentAssertions, Moq（适用于.NET应用程序）
- **测试数据管理**: [测试数据创建和清理的方法]
- **CI/CD集成**: [GitHub Actions流水线中的自动化测试]
- **覆盖率要求**: [最低代码覆盖率阈值]
- **性能测试**: [负载和性能测试的方法]

## 7. 原理与背景

[解释需求、约束和指南背后的理由。提供设计决策的背景。]

## 8. 依赖关系与外部集成

[定义本规范所需的外部系统、服务和架构依赖关系。关注**需要什么**而不是**如何实现**。除非是架构约束，否则避免指定具体的包或库版本。]

### 外部系统
- **EXT-001**: [外部系统名称] - [目的和集成类型]

### 第三方服务
- **SVC-001**: [服务名称] - [所需能力和SLA要求]

### 基础设施依赖
- **INF-001**: [基础设施组件] - [要求和约束]

### 数据依赖
- **DAT-001**: [外部数据源] - [格式、频率和访问要求]

### 技术平台依赖
- **PLT-001**: [平台/运行时要求] - [版本约束和理由]

### 合规依赖
- **COM-001**: [法规或合规要求] - [对实现的影响]

**注意**: 本节应关注架构和业务依赖，而非具体的包实现。例如，指定“OAuth 2.0身份验证库”而不是“Microsoft.AspNetCore.Authentication.JwtBearer v6.0.1”。

## 9. 示例与边界情况

    ```code
    // 代码片段或数据示例，展示指南的正确应用，包括边界情况
    ```

## 10. 验证标准

[列出必须满足的标准或测试，以符合本规范。]

## 11. 相关规范/延伸阅读

[链接到相关规范1]
[链接到相关外部文档]