---
description: "检查指令创建指南"
---

本指南用于创建新的检查指令文件，为特定功能模块的开发、维护和修改提供完整的上下文信息。

## 检查指令文件结构规范

### 1. 文件命名规范
- 格式：`check-[模块名]-[功能描述].md`
- 示例：`check-live-直播相关文件检查.md`
- 要求：使用英文模块名和中文功能描述

### 2. 文件头部元数据
```markdown
---
description: "[功能描述]检查指令"
---
```

### 3. 核心内容结构

#### 3.1 检查范围
列出需要检查的所有相关文件和组件：
```markdown
## 检查范围

### 1. [组件类别] (`文件路径/`)
- **文件名**: 功能描述
- **文件名**: 功能描述

### 2. [页面类别] (`文件路径/`)
- 页面功能描述
```

#### 3.2 详细检查结果
使用 ✅ 标记实现情况：
```markdown
## 详细检查结果

### [组件名]实现情况

#### 文件名 (功能描述)
- ✅ **功能点**: 描述
- ✅ **功能点**: 描述
- ⚠️ **待完善**: 描述
```

#### 3.3 功能特性
列出已实现的核心功能：
```markdown
## 功能特性

### 已实现功能
1. **功能类别**
   - 具体功能点
   - 具体功能点

2. **管理功能**
   - 具体管理操作
   - 具体管理操作
```

#### 3.4 技术实现
描述技术栈和关键实现：
```markdown
### 技术实现
- **技术栈**: 使用的技术框架和库
- **数据存储**: 数据库字段设计
- **类型安全**: TypeScript类型定义
- **验证机制**: 数据验证方案
- **错误处理**: 错误处理机制
```

#### 3.5 使用示例
提供代码使用示例：
```markdown
## 使用示例

### 功能调用示例
```typescript
// 代码示例
const result = await functionCall();
```
```

#### 3.6 环境配置
列出必需的环境变量和配置：
```markdown
## 环境配置要求

### 必需环境变量
```bash
CONFIG_KEY=your_config_value
ANOTHER_KEY=your_another_value
```
```

### 3.7 修改前检查清单（可选）
对于复杂组件，添加修改风险评估：
```markdown
## 修改前检查清单

### ✅ 架构一致性检查
- [ ] 是否遵循现有的组件分层结构？
- [ ] 是否保持类型定义的完整性？
- [ ] 是否兼容现有的数据流模式？

### ✅ 功能影响评估
- [ ] 修改是否会影响核心功能？
- [ ] 修改是否会影响数据一致性？
```

### 3.8 潜在风险点（可选）
标识高风险修改区域：
```markdown
### 潜在修改风险点

#### 高风险区域：
1. **核心逻辑** - 修改可能影响主要功能
2. **状态管理** - 多个状态需要保持同步

#### 中等风险区域：
1. **UI布局** - 修改可能影响显示效果

#### 低风险区域：
1. **样式调整** - 视觉修改
```

## 检查指令创建流程

### 1. 确定检查目标
- 明确要检查的功能模块
- 确定相关的文件和组件范围

### 2. 收集信息
- 查看相关源代码文件
- 分析功能实现细节
- 记录技术栈和依赖关系

### 3. 编写检查内容
- 按照标准结构组织内容
- 使用 ✅ 标记实现情况
- 提供完整的使用示例

### 4. 添加风险评估
- 对于复杂组件，添加修改前检查清单
- 标识潜在的风险点

### 5. 验证完整性
- 确保所有相关文件都被覆盖
- 检查示例代码的正确性
- 验证环境配置信息

## 最佳实践

### 1. 内容组织
- 使用清晰的层级结构
- 保持内容简洁但完整
- 使用表格和列表提高可读性

### 2. 技术细节
- 包含完整的类型定义
- 描述数据流和状态管理
- 记录关键的业务逻辑

### 3. 风险评估
- 客观评估修改风险
- 提供具体的风险描述
- 建议规避风险的方法

### 4. 示例代码
- 提供真实可用的代码示例
- 包含必要的导入和上下文
- 使用正确的语法和格式

## 模板示例

```markdown
---
description: "[模块名]相关文件检查指令"
---

本指令用于检查项目中[模块名]相关的文件实现情况，为后续[功能描述]开发和维护提供上下文信息。

## 检查范围

### 1. [组件类别] (`src/path/to/components/`)
- **ComponentA.tsx**: 主要功能描述
- **ComponentB.tsx**: 辅助功能描述

### 2. [服务类别] (`src/path/to/services/`)
- **service.ts**: 业务逻辑实现

## 详细检查结果

### 组件实现情况

#### ComponentA.tsx (主要组件)
- ✅ **核心功能**: 功能描述
- ✅ **状态管理**: 状态管理描述
- ✅ **错误处理**: 错误处理机制

## 功能特性

### 已实现功能
1. **主要功能**
   - 功能点1
   - 功能点2

2. **辅助功能**
   - 功能点3
   - 功能点4

## 使用示例

### 功能调用
```typescript
import { useFeature } from '@/path/to/hook';

const { data, isLoading } = useFeature(params);
```

## 环境配置

### 必需配置
```bash
FEATURE_ENABLED=true
API_ENDPOINT=https://api.example.com
```

## 修改前检查清单

### ✅ 兼容性检查
- [ ] 修改是否影响现有功能？
- [ ] 修改是否需要更新类型定义？
```

通过遵循这个指南，您可以创建结构清晰、内容完整的检查指令文件，为开发团队提供有价值的技术上下文信息。