记录下AI使用标准

哈哈哈_是我
112 阅读5分钟

AI日常使用操作标准（Vue+Vite / OSGi 团队版）

一、总体原则

  1. AI为辅助，不替代人工判断​ —— 所有 AI 输出必须经人工校验才能进入代码库或交付。
  2. 输入明确​ —— Prompt 必须含 任务类型 + 输入来源(相对路径/文件内容) + 约束条件 + 输出格式。
  3. 安全合规​ —— 禁止向 AI 输入生产数据、用户隐私、涉密信息。
  4. 可追溯​ —— AI 生成内容标注 [AI-gen]，人工修改部分标注 [Manual-fix]，并记录来源路径。

二、分环节操作标准与示例

1. 代码审查（Code Review）

用 AI 快速定位潜在问题，人工复核确认。

前端（Vue + Vite）

  • Prompt 模板​
任务：Vue组件代码审查  
输入路径：src/components/UserList.vue  
约束：检查项=性能(不必要的re-render/大列表优化)、可访问性(a11y)、Vue3 Composition API 使用规范、Vite构建相关警告  
输出：问题列表(行号+问题描述+修复建议)，按优先级排序
  • 示例操作​ ① 将 src/components/UserList.vue内容贴入 Prompt，或直接在支持文件引用的环境中指定路径。 ② AI 输出示例：
[AI-gen]
1. 行23：v-for未使用key属性 → 建议添加唯一key (如 :key="user.id")  
2. 行45：computed属性依赖未在setup顶层声明 → 可能导致响应式失效  
优先级：高

③ 开发者在 PR 中标注 AI 发现问题并完成修复。

后端（OSGi Framework）

  • Prompt 模板​
任务：OSGi Bundle代码审查  
输入路径：bundle/com.example.user.service/src/com/example/service/UserService.java  
约束：检查项=服务注册/注销生命周期、线程安全、异常处理、依赖注入(@Reference)使用规范  
输出：风险等级(H/M/L)+行号+问题描述+修复建议
  • 示例操作​ ① 提供 UserService.java相对路径或内容。 ② AI 输出示例：
[AI-gen]
行88：@Activate方法未捕获异常 → 高等级风险，建议try-catch并记录日志  
行112：服务引用未判空直接使用 → 中等级风险

③ 人工复核生命周期管理逻辑，确保与 OSGi 容器兼容。

2. 代码注释

AI 生成符合团队规范的注释，人工校验语义准确性。

前端（Vue + Vite）

  • 标准：单文件组件需在 <script setup>或 methods上方加 JSDoc；Props 用 @prop说明类型与含义。
  • Prompt 模板​
任务：为Vue组件添加JSDoc注释  
输入路径：src/components/ProductCard.vue  
约束：含Props、Emits、关键方法说明；遵循团队注释模板  
输出：完整带注释的组件代码
  • 示例输出片段​
/**
 * 商品卡片组件
 * @prop {Object} product - 商品数据对象
 * @prop {Function} onAddToCart - 添加到购物车回调
 */

后端（OSGi）

  • 标准：Bundle类、服务接口需 JavaDoc，含用途、参数、异常。
  • Prompt 模板​
任务：为OSGi服务类生成JavaDoc  
输入路径：bundle/com.example.order.impl/src/com/example/order/OrderServiceImpl.java  
约束：含类说明、方法说明、@throws标注  
输出：带JavaDoc的完整类代码

3. 开发文档（Markdown）

统一 MD 模板，AI 生成后人工补充业务背景与变更记录。

  • 通用 MD 模板​
## 功能概述  
## 接口/组件说明  
## 参数与返回值  
## 示例  
## 注意事项
  • Prompt 模板（前端示例） ​
任务：根据Vue组件生成接口/使用文档  
输入路径：src/components/PaymentForm.vue  
约束：使用团队MD模板，含Props、事件、示例代码  
输出：PaymentForm.md内容
  • Prompt 模板（后端示例） ​
任务：根据OSGi服务生成接口文档  
输入路径：bundle/com.example.pay.api/src/com/example/pay/PaymentService.java  
约束：MD模板，含方法签名、参数说明、异常说明  
输出：PaymentService.md内容

4. 读取需求生成代码

从需求段落生成初始代码骨架，人工补全业务逻辑与测试。

前端（Vue + Vite）

  • Prompt 模板​
任务：根据需求生成Vue3组件代码  
需求：[粘贴PRD段落：用户可在表单中选择支付方式并提交]  
约束：使用Vue3 Composition API + <script setup>，UI库=Element Plus，路径=src/components/PaymentForm.vue  
输出：完整 .vue 文件代码
  • 后续操作​ ① 运行 npm run lint && npm run dev检查语法与预览效果。 ② 补全表单校验、接口调用等业务逻辑。

后端（OSGi）

  • Prompt 模板​
任务：根据需求生成OSGi服务接口与实现骨架  
需求：[粘贴PRD段落：系统需提供支付订单接口，支持同步返回结果]  
约束：使用OSGi Declarative Services，接口路径=bundle/com.example.pay.api，实现路径=bundle/com.example.pay.impl  
输出：接口Java文件+实现Java文件
  • 后续操作​ ① 补全事务控制、异常处理、日志记录。 ② 编写单元测试验证服务生命周期与业务方法。

三、团队管理与推进

  1. Prompt模板库（GitLab Wiki/Confluence）

    • 按场景存放：代码审查、注释生成、文档生成、需求转代码。
    • 每个模板固定结构：任务 | 输入路径 | 约束 | 输出格式。

  2. 代码审查流程​

    • MR/PR模板加 “AI审查结果” 栏，必须填写问题列表与修复情况。

  3. 培训与考核​

    • 新员工培训：Prompt编写技巧 + 相对路径引用方法。
    • 每月复盘：展示优秀/失败案例，更新模板。

  4. 工具链支持​

    • IDE插件或 CLI 封装调用（例如 ai-review --path src/components/X.vue --type vue）。
    • CI 检查 AI 输出格式是否符合团队规范（关键词、结构）。

四、语义与格式要求

  • Prompt：四要素齐全（任务、输入路径/内容、约束、输出格式）。
  • 输出：列点/表格，术语统一（userId≠ uid），必要时加行号。
  • 标注：[AI-gen]与 [Manual-fix]并用，保留来源路径以便追溯。
avatar
文章
阅读
粉丝