AI助手配置规范 v1.0

能力定义

• 代码生成：支持TypeScript/React语法，遵循ESLint规则
• 文档生成：自动创建API文档，格式符合JSDoc标准
• 重构建议：识别性能瓶颈并提供优化方案

约束条件

• 禁止生成未经验证的第三方库调用
• 敏感操作需添加// @security-review标记
• 所有SQL操作必须使用参数化查询

项目规范

• 组件命名：采用PascalCase（如UserProfile）
• 状态管理：优先使用React Context API
• 错误处理：必须包含try/catch块并记录错误日志

### 3.3 高级配置技巧
#### 多环境适配
通过条件块实现环境差异化配置：
```markdown
## 环境配置
### @env:development
- 启用详细调试日志
- 允许使用测试数据生成工具

### @env:production
- 禁用调试信息输出
- 强制代码压缩与混淆

团队角色划分

为不同角色定制AI行为：

## 角色配置
### @role:junior
- 提供详细代码注释建议
- 自动检测并修复基础语法错误

### @role:senior
- 提供架构优化建议
- 生成性能基准测试代码

四、错误配置案例与修正方案

4.1 常见错误示例

❌ 错误配置：

# 错误示例
- 生成所有需要的代码
- 帮忙写注释
- 修复bug

问题分析：过度模糊的指令导致AI行为不可控，可能生成不符合项目规范的代码。

✅ 修正方案：

# 代码生成规范
## 注释生成
- 为所有函数添加JSDoc风格注释
- 包含@param、@returns和@throws标签
- 复杂逻辑需添加步骤说明

## Bug修复流程
1. 先分析错误原因并添加注释说明
2. 提供2-3种解决方案及利弊分析
3. 修复代码需包含单元测试

4.2 安全隐患配置

❌ 错误配置：

# 权限设置
- 允许AI访问数据库凭证
- 自动生成管理员权限代码

问题分析：直接暴露敏感信息，违反安全最佳实践。

✅ 修正方案：

# 安全配置
## 凭证管理
- 使用环境变量引用敏感信息（如`process.env.DB_PASSWORD`）
- 生成代码中必须包含权限检查逻辑
- 数据库操作需通过ORM框架实现，禁止原生SQL

五、行业落地案例

5.1 金融科技项目应用

场景：某支付系统需要严格遵守PCI DSS合规要求 实施：在AGENTS.md中定义：

## 合规配置
- 所有信用卡处理代码必须使用加密传输
- 禁止日志记录完整卡号（需脱敏显示前6后4位）
- 交易操作必须包含双因素验证逻辑

效果：合规问题检出率从68%提升至99%，通过PCI DSS认证时间缩短40%

5.2 医疗软件项目应用

场景：电子病历系统需符合HIPAA隐私规范 实施：关键配置如下：

## 隐私保护
- 患者数据必须使用AES-256加密存储
- 查询操作需记录审计日志（包含操作者ID与时间戳）
- 生成代码中禁止包含患者姓名、社保号等直接标识符